diff --git a/generated/PyMaterialXCore.ElementEquivalenceOptions.html b/generated/PyMaterialXCore.ElementEquivalenceOptions.html index f30bd4a..77bde5e 100644 --- a/generated/PyMaterialXCore.ElementEquivalenceOptions.html +++ b/generated/PyMaterialXCore.ElementEquivalenceOptions.html @@ -58,26 +58,22 @@

Properties
format
-

No docstring available for PyMaterialXCore.ElementEquivalenceOptions.format

-
+
precision
-

No docstring available for PyMaterialXCore.ElementEquivalenceOptions.precision

-
+
skipAttributes
-

No docstring available for PyMaterialXCore.ElementEquivalenceOptions.skipAttributes

-
+
skipValueComparisons
-

No docstring available for PyMaterialXCore.ElementEquivalenceOptions.skipValueComparisons

-
+
diff --git a/generated/PyMaterialXCore.ElementEquivalenceResult.html b/generated/PyMaterialXCore.ElementEquivalenceResult.html index 86d4e3e..60c6b1f 100644 --- a/generated/PyMaterialXCore.ElementEquivalenceResult.html +++ b/generated/PyMaterialXCore.ElementEquivalenceResult.html @@ -88,26 +88,22 @@

Properties
attributeName
-

No docstring available for PyMaterialXCore.ElementEquivalenceResult.attributeName

-
+
differenceType
-

No docstring available for PyMaterialXCore.ElementEquivalenceResult.differenceType

-
+
path1
-

No docstring available for PyMaterialXCore.ElementEquivalenceResult.path1

-
+
path2
-

No docstring available for PyMaterialXCore.ElementEquivalenceResult.path2

-
+

diff --git a/generated/PyMaterialXCore.Matrix33.html b/generated/PyMaterialXCore.Matrix33.html index b856aff..86d9241 100644 --- a/generated/PyMaterialXCore.Matrix33.html +++ b/generated/PyMaterialXCore.Matrix33.html @@ -105,8 +105,7 @@

Properties
IDENTITY = <PyMaterialXCore.Matrix33 object>
-

No docstring available for PyMaterialXCore.Matrix33.IDENTITY

-
+

diff --git a/generated/PyMaterialXCore.Matrix44.html b/generated/PyMaterialXCore.Matrix44.html index 24a581a..47f41c6 100644 --- a/generated/PyMaterialXCore.Matrix44.html +++ b/generated/PyMaterialXCore.Matrix44.html @@ -111,8 +111,7 @@

Properties
IDENTITY = <PyMaterialXCore.Matrix44 object>
-

No docstring available for PyMaterialXCore.Matrix44.IDENTITY

-
+

diff --git a/generated/PyMaterialXFormat.ExceptionFileMissing.html b/generated/PyMaterialXFormat.ExceptionFileMissing.html index c9a929e..c81cd3c 100644 --- a/generated/PyMaterialXFormat.ExceptionFileMissing.html +++ b/generated/PyMaterialXFormat.ExceptionFileMissing.html @@ -39,6 +39,12 @@

PyMaterialXFormat.ExceptionFileMissing exception ExceptionFileMissing

Bases: Exception

+

A type of exception that is raised when a requested file cannot be opened.

+
+
See:
+

https://materialx.org/docs/api/class_exception_file_missing.html

+
+

diff --git a/generated/PyMaterialXFormat.ExceptionParseError.html b/generated/PyMaterialXFormat.ExceptionParseError.html index 2fc0baa..29ad2df 100644 --- a/generated/PyMaterialXFormat.ExceptionParseError.html +++ b/generated/PyMaterialXFormat.ExceptionParseError.html @@ -39,6 +39,13 @@

PyMaterialXFormat.ExceptionParseError exception ExceptionParseError

Bases: Exception

+

A type of exception that is raised when a requested document cannot be +parsed.

+
+
See:
+

https://materialx.org/docs/api/class_exception_parse_error.html

+
+
diff --git a/generated/PyMaterialXFormat.FilePath.html b/generated/PyMaterialXFormat.FilePath.html index d4d5983..5c79ce7 100644 --- a/generated/PyMaterialXFormat.FilePath.html +++ b/generated/PyMaterialXFormat.FilePath.html @@ -39,6 +39,12 @@

PyMaterialXFormat.FilePath class FilePath

Bases: pybind11_object

+

A generic file path, supporting both syntactic and file system operations.

+
+
See:
+

https://materialx.org/docs/api/class_file_path.html

+
+

Methods

diff --git a/generated/PyMaterialXFormat.FileSearchPath.html b/generated/PyMaterialXFormat.FileSearchPath.html index 2cae64e..b653b4b 100644 --- a/generated/PyMaterialXFormat.FileSearchPath.html +++ b/generated/PyMaterialXFormat.FileSearchPath.html @@ -39,6 +39,13 @@

PyMaterialXFormat.FileSearchPath class FileSearchPath

Bases: pybind11_object

+

A sequence of file paths, which may be queried to find the first instance +of a given filename on the file system.

+
+
See:
+

https://materialx.org/docs/api/class_file_search_path.html

+
+

Methods

diff --git a/generated/PyMaterialXFormat.Format.html b/generated/PyMaterialXFormat.Format.html index e82b2a2..9d5b18e 100644 --- a/generated/PyMaterialXFormat.Format.html +++ b/generated/PyMaterialXFormat.Format.html @@ -39,10 +39,20 @@

PyMaterialXFormat.Format class Format

Bases: pybind11_object

+
+

Members:

-

FormatWindows

-

FormatPosix

-

FormatNative

+
+

FormatWindows : Format indicating a Windows environment.

+

FormatPosix : Format indicating a Linux or Mac environment.

+

FormatNative : Format indicating the format used on the system for which the library was built.

+

Methods

@@ -56,32 +66,27 @@

Properties
FormatNative = <Format.FormatPosix: 1>
-

No docstring available for PyMaterialXFormat.Format.FormatNative

-
+
FormatPosix = <Format.FormatPosix: 1>
-

No docstring available for PyMaterialXFormat.Format.FormatPosix

-
+
FormatWindows = <Format.FormatWindows: 0>
-

No docstring available for PyMaterialXFormat.Format.FormatWindows

-
+
name
-

No docstring available for PyMaterialXFormat.Format.name

-
+
value
-

No docstring available for PyMaterialXFormat.Format.value

-
+
diff --git a/generated/PyMaterialXFormat.Type.html b/generated/PyMaterialXFormat.Type.html index e6b8763..bbde7ee 100644 --- a/generated/PyMaterialXFormat.Type.html +++ b/generated/PyMaterialXFormat.Type.html @@ -39,10 +39,20 @@

PyMaterialXFormat.Type class Type

Bases: pybind11_object

+
+

Members:

-

TypeRelative

-

TypeAbsolute

-

TypeNetwork

+
+

TypeRelative : Type indicating a relative path, e.g. 'a/b'. This is the default file path type.

+

TypeAbsolute : Type indicating an absolute path, e.g. '/a/b'.

+

TypeNetwork : Type indicating a network path on Windows, e.g. '\ab'.

+

Methods

@@ -56,32 +66,27 @@

Properties
TypeAbsolute = <Type.TypeAbsolute: 1>
-

No docstring available for PyMaterialXFormat.Type.TypeAbsolute

-
+
TypeNetwork = <Type.TypeNetwork: 2>
-

No docstring available for PyMaterialXFormat.Type.TypeNetwork

-
+
TypeRelative = <Type.TypeRelative: 0>
-

No docstring available for PyMaterialXFormat.Type.TypeRelative

-
+
name
-

No docstring available for PyMaterialXFormat.Type.name

-
+
value
-

No docstring available for PyMaterialXFormat.Type.value

-
+
diff --git a/generated/PyMaterialXFormat.XmlReadOptions.html b/generated/PyMaterialXFormat.XmlReadOptions.html index 3913384..a77f3a1 100644 --- a/generated/PyMaterialXFormat.XmlReadOptions.html +++ b/generated/PyMaterialXFormat.XmlReadOptions.html @@ -39,6 +39,12 @@

PyMaterialXFormat.XmlReadOptions class XmlReadOptions

Bases: pybind11_object

+

A set of options for controlling the behavior of XML read functions.

+
+
See:
+

https://materialx.org/docs/api/class_xml_read_options.html

+
+

Methods

@@ -52,32 +58,27 @@

Properties
parentXIncludes
-

No docstring available for PyMaterialXFormat.XmlReadOptions.parentXIncludes

-
+
readComments
-

No docstring available for PyMaterialXFormat.XmlReadOptions.readComments

-
+
readNewlines
-

No docstring available for PyMaterialXFormat.XmlReadOptions.readNewlines

-
+
readXIncludeFunction
-

No docstring available for PyMaterialXFormat.XmlReadOptions.readXIncludeFunction

-
+
upgradeVersion
-

No docstring available for PyMaterialXFormat.XmlReadOptions.upgradeVersion

-
+
diff --git a/generated/PyMaterialXFormat.XmlWriteOptions.html b/generated/PyMaterialXFormat.XmlWriteOptions.html index dcec2fc..b442127 100644 --- a/generated/PyMaterialXFormat.XmlWriteOptions.html +++ b/generated/PyMaterialXFormat.XmlWriteOptions.html @@ -39,6 +39,12 @@

PyMaterialXFormat.XmlWriteOptions class XmlWriteOptions

Bases: pybind11_object

+

A set of options for controlling the behavior of XML write functions.

+
+
See:
+

https://materialx.org/docs/api/class_xml_write_options.html

+
+

Methods

@@ -52,14 +58,12 @@

Properties
elementPredicate
-

No docstring available for PyMaterialXFormat.XmlWriteOptions.elementPredicate

-
+
writeXIncludeEnable
-

No docstring available for PyMaterialXFormat.XmlWriteOptions.writeXIncludeEnable

-
+
diff --git a/generated/PyMaterialXFormat.html b/generated/PyMaterialXFormat.html index 4a30bc6..d21d8b7 100644 --- a/generated/PyMaterialXFormat.html +++ b/generated/PyMaterialXFormat.html @@ -41,22 +41,22 @@

Classes

- + - + - + - + - + - +

FilePath

A generic file path, supporting both syntactic and file system operations.

FileSearchPath

A sequence of file paths, which may be queried to find the first instance of a given filename on the file system.

Format

Members:

Enumeration of FilePath formats.

Type

Members:

Enumeration of FilePath types.

XmlReadOptions

A set of options for controlling the behavior of XML read functions.

XmlWriteOptions

A set of options for controlling the behavior of XML write functions.
@@ -66,10 +66,10 @@

Exception Types

ExceptionFileMissing

-

+

A type of exception that is raised when a requested file cannot be opened.

ExceptionParseError

-

+

A type of exception that is raised when a requested document cannot be parsed.

@@ -123,7 +123,7 @@

Module Functions

-flattenFilenames(doc: Document, searchPath: FileSearchPath = <FileSearchPath object at 0x106db3cf0>, customResolver: StringResolver = None) → None
+flattenFilenames(doc: Document, searchPath: FileSearchPath = <FileSearchPath object at 0x107d034b0>, customResolver: StringResolver = None) → None
@@ -153,7 +153,7 @@

PyMaterialXFormat Module Function Documentation
-loadLibrary(file: FilePath, doc: Document, searchPath: FileSearchPath = <FileSearchPath object at 0x106db2cf0>, readOptions: XmlReadOptions = None) → None
+loadLibrary(file: FilePath, doc: Document, searchPath: FileSearchPath = <FileSearchPath object at 0x107d03230>, readOptions: XmlReadOptions = None) → None

@@ -168,12 +168,12 @@

PyMaterialXFormat Module Function Documentation
-readFromXmlFileBase(doc: Document, filename: FilePath, searchPath: FileSearchPath = <FileSearchPath object at 0x106deae30>, readOptions: XmlReadOptions = None) → None
+readFromXmlFileBase(doc: Document, filename: FilePath, searchPath: FileSearchPath = <FileSearchPath object at 0x107d17a70>, readOptions: XmlReadOptions = None) → None

-readFromXmlString(doc: Document, str: str, searchPath: FileSearchPath = <FileSearchPath object at 0x106de85b0>, readOptions: XmlReadOptions = None) → None
+readFromXmlString(doc: Document, str: str, searchPath: FileSearchPath = <FileSearchPath object at 0x107d159b0>, readOptions: XmlReadOptions = None) → None
diff --git a/generated/PyMaterialXGenGlsl.EsslShaderGenerator.html b/generated/PyMaterialXGenGlsl.EsslShaderGenerator.html index f396666..7bb0a1d 100644 --- a/generated/PyMaterialXGenGlsl.EsslShaderGenerator.html +++ b/generated/PyMaterialXGenGlsl.EsslShaderGenerator.html @@ -39,6 +39,12 @@

PyMaterialXGenGlsl.EsslShaderGenerator class EsslShaderGenerator

Bases: GlslShaderGenerator

+

An ESSL (OpenGL ES Shading Language) shader generator.

+
+
See:
+

https://materialx.org/docs/api/class_essl_shader_generator.html

+
+

Methods

diff --git a/generated/PyMaterialXGenGlsl.GlslResourceBindingContext.html b/generated/PyMaterialXGenGlsl.GlslResourceBindingContext.html index ba946fe..9ecd95d 100644 --- a/generated/PyMaterialXGenGlsl.GlslResourceBindingContext.html +++ b/generated/PyMaterialXGenGlsl.GlslResourceBindingContext.html @@ -39,6 +39,13 @@

PyMaterialXGenGlsl.GlslResourceBindingContext class GlslResourceBindingContext

Bases: HwResourceBindingContext

+

Class representing a resource binding for GLSL (OpenGL Shading Language) +shader resources.

+
+
See:
+

https://materialx.org/docs/api/class_glsl_resource_binding_context.html

+
+

Methods

diff --git a/generated/PyMaterialXGenGlsl.GlslShaderGenerator.html b/generated/PyMaterialXGenGlsl.GlslShaderGenerator.html index 2578013..5ddb78d 100644 --- a/generated/PyMaterialXGenGlsl.GlslShaderGenerator.html +++ b/generated/PyMaterialXGenGlsl.GlslShaderGenerator.html @@ -39,6 +39,13 @@

PyMaterialXGenGlsl.GlslShaderGenerator class GlslShaderGenerator

Bases: HwShaderGenerator

+

Base class for GLSL (OpenGL Shading Language) code generation.

+

A generator for a specific GLSL target should be derived from this class.

+
+
See:
+

https://materialx.org/docs/api/class_glsl_shader_generator.html

+
+

Methods

diff --git a/generated/PyMaterialXGenGlsl.VkShaderGenerator.html b/generated/PyMaterialXGenGlsl.VkShaderGenerator.html index 41d17d2..4ee4a36 100644 --- a/generated/PyMaterialXGenGlsl.VkShaderGenerator.html +++ b/generated/PyMaterialXGenGlsl.VkShaderGenerator.html @@ -39,6 +39,12 @@

PyMaterialXGenGlsl.VkShaderGenerator class VkShaderGenerator

Bases: GlslShaderGenerator

+

A Vulkan GLSL (OpenGL Shading Language) shader generator.

+
+
See:
+

https://materialx.org/docs/api/class_vk_shader_generator.html

+
+

Methods

diff --git a/generated/PyMaterialXGenGlsl.html b/generated/PyMaterialXGenGlsl.html index a0f4faf..fd229d9 100644 --- a/generated/PyMaterialXGenGlsl.html +++ b/generated/PyMaterialXGenGlsl.html @@ -41,16 +41,16 @@

Classes

- + - + - + - +

EsslShaderGenerator

An ESSL (OpenGL ES Shading Language) shader generator.

GlslResourceBindingContext

Class representing a resource binding for GLSL (OpenGL Shading Language) shader resources.

GlslShaderGenerator

Base class for GLSL (OpenGL Shading Language) code generation.

VkShaderGenerator

A Vulkan GLSL (OpenGL Shading Language) shader generator.
diff --git a/generated/PyMaterialXGenMdl.MdlShaderGenerator.html b/generated/PyMaterialXGenMdl.MdlShaderGenerator.html index fef4904..42feb07 100644 --- a/generated/PyMaterialXGenMdl.MdlShaderGenerator.html +++ b/generated/PyMaterialXGenMdl.MdlShaderGenerator.html @@ -39,6 +39,12 @@

PyMaterialXGenMdl.MdlShaderGenerator class MdlShaderGenerator

Bases: ShaderGenerator

+

Shader generator for MDL (Material Definition Language).

+
+
See:
+

https://materialx.org/docs/api/class_mdl_shader_generator.html

+
+

Methods

diff --git a/generated/PyMaterialXGenMdl.html b/generated/PyMaterialXGenMdl.html index 1350c88..1570bea 100644 --- a/generated/PyMaterialXGenMdl.html +++ b/generated/PyMaterialXGenMdl.html @@ -41,7 +41,7 @@

Classes

- +

MdlShaderGenerator

Shader generator for MDL (Material Definition Language).
diff --git a/generated/PyMaterialXGenMsl.MslResourceBindingContext.html b/generated/PyMaterialXGenMsl.MslResourceBindingContext.html index 17b5716..df27be6 100644 --- a/generated/PyMaterialXGenMsl.MslResourceBindingContext.html +++ b/generated/PyMaterialXGenMsl.MslResourceBindingContext.html @@ -39,6 +39,7 @@

PyMaterialXGenMsl.MslResourceBindingContext class MslResourceBindingContext

Bases: HwResourceBindingContext

+

Class representing a resource binding for MSL shader resources.

Methods

diff --git a/generated/PyMaterialXGenMsl.MslShaderGenerator.html b/generated/PyMaterialXGenMsl.MslShaderGenerator.html index f94adc6..f969b5a 100644 --- a/generated/PyMaterialXGenMsl.MslShaderGenerator.html +++ b/generated/PyMaterialXGenMsl.MslShaderGenerator.html @@ -39,6 +39,8 @@

PyMaterialXGenMsl.MslShaderGenerator class MslShaderGenerator

Bases: HwShaderGenerator

+

Base class for MSL (Metal Shading Language) code generation.

+

A generator for a specific MSL target should be derived from this class.

Methods

diff --git a/generated/PyMaterialXGenMsl.html b/generated/PyMaterialXGenMsl.html index 1848866..0d82b8d 100644 --- a/generated/PyMaterialXGenMsl.html +++ b/generated/PyMaterialXGenMsl.html @@ -41,10 +41,10 @@

Classes

- + - +

MslResourceBindingContext

Class representing a resource binding for MSL shader resources.

MslShaderGenerator

Base class for MSL (Metal Shading Language) code generation.
diff --git a/generated/PyMaterialXGenOsl.OslShaderGenerator.html b/generated/PyMaterialXGenOsl.OslShaderGenerator.html index 3dd2366..56d63d7 100644 --- a/generated/PyMaterialXGenOsl.OslShaderGenerator.html +++ b/generated/PyMaterialXGenOsl.OslShaderGenerator.html @@ -39,6 +39,13 @@

PyMaterialXGenOsl.OslShaderGenerator class OslShaderGenerator

Bases: ShaderGenerator

+

Base class for OSL (Open Shading Language) shader generators.

+

A generator for a specific OSL target should be derived from this class.

+
+
See:
+

https://materialx.org/docs/api/class_osl_shader_generator.html

+
+

Methods

diff --git a/generated/PyMaterialXGenOsl.html b/generated/PyMaterialXGenOsl.html index 133770f..eb4e72a 100644 --- a/generated/PyMaterialXGenOsl.html +++ b/generated/PyMaterialXGenOsl.html @@ -41,7 +41,7 @@

Classes

- +

OslShaderGenerator

Base class for OSL (Open Shading Language) shader generators.
diff --git a/generated/PyMaterialXGenShader.ApplicationVariableHandler.html b/generated/PyMaterialXGenShader.ApplicationVariableHandler.html index f79b4a7..21fc2c4 100644 --- a/generated/PyMaterialXGenShader.ApplicationVariableHandler.html +++ b/generated/PyMaterialXGenShader.ApplicationVariableHandler.html @@ -39,6 +39,8 @@

PyMaterialXGenShader.ApplicationVariableHandler class ApplicationVariableHandler

Bases: pybind11_object

+

A function to allow for handling of application variables for a given node.

+

Is expected to take a ShaderNode and a GenContext, and not return anything.

Methods

diff --git a/generated/PyMaterialXGenShader.ColorManagementSystem.html b/generated/PyMaterialXGenShader.ColorManagementSystem.html index b59ea39..233f6af 100644 --- a/generated/PyMaterialXGenShader.ColorManagementSystem.html +++ b/generated/PyMaterialXGenShader.ColorManagementSystem.html @@ -39,6 +39,12 @@

PyMaterialXGenShader.ColorManagementSystem class ColorManagementSystem

Bases: pybind11_object

+

Abstract base class for color management systems.

+
+
See:
+

https://materialx.org/docs/api/class_color_management_system.html

+
+

Methods

diff --git a/generated/PyMaterialXGenShader.ColorSpaceTransform.html b/generated/PyMaterialXGenShader.ColorSpaceTransform.html index 1e260ad..ceab43c 100644 --- a/generated/PyMaterialXGenShader.ColorSpaceTransform.html +++ b/generated/PyMaterialXGenShader.ColorSpaceTransform.html @@ -39,6 +39,12 @@

PyMaterialXGenShader.ColorSpaceTransform class ColorSpaceTransform

Bases: pybind11_object

+

Structure that represents color space transform information.

+
+
See:
+

https://materialx.org/docs/api/struct_color_space_transform.html

+
+

Methods

@@ -52,20 +58,17 @@

Properties
sourceSpace
-

No docstring available for PyMaterialXGenShader.ColorSpaceTransform.sourceSpace

-
+
targetSpace
-

No docstring available for PyMaterialXGenShader.ColorSpaceTransform.targetSpace

-
+
type
-

No docstring available for PyMaterialXGenShader.ColorSpaceTransform.type

-
+
diff --git a/generated/PyMaterialXGenShader.DefaultColorManagementSystem.html b/generated/PyMaterialXGenShader.DefaultColorManagementSystem.html index ee72728..ace9cb7 100644 --- a/generated/PyMaterialXGenShader.DefaultColorManagementSystem.html +++ b/generated/PyMaterialXGenShader.DefaultColorManagementSystem.html @@ -39,6 +39,12 @@

PyMaterialXGenShader.DefaultColorManagementSystem class DefaultColorManagementSystem

Bases: ColorManagementSystem

+

Class for a default color management system.

+
+
See:
+

https://materialx.org/docs/api/class_default_color_management_system.html

+
+

Methods

diff --git a/generated/PyMaterialXGenShader.GenContext.html b/generated/PyMaterialXGenShader.GenContext.html index 957b6b4..2d17ff8 100644 --- a/generated/PyMaterialXGenShader.GenContext.html +++ b/generated/PyMaterialXGenShader.GenContext.html @@ -39,6 +39,13 @@

PyMaterialXGenShader.GenContext class GenContext

Bases: pybind11_object

+

A context class for shader generation.

+

Used for thread local storage of data needed during shader generation.

+
+
See:
+

https://materialx.org/docs/api/class_gen_context.html

+
+

Methods

diff --git a/generated/PyMaterialXGenShader.GenOptions.html b/generated/PyMaterialXGenShader.GenOptions.html index 33bcbab..2ca6a29 100644 --- a/generated/PyMaterialXGenShader.GenOptions.html +++ b/generated/PyMaterialXGenShader.GenOptions.html @@ -39,6 +39,12 @@

PyMaterialXGenShader.GenOptions class GenOptions

Bases: pybind11_object

+

Class holding options to configure shader generation.

+
+
See:
+

https://materialx.org/docs/api/class_gen_options.html

+
+

Methods

@@ -52,109 +58,155 @@

Properties
addUpstreamDependencies
-

No docstring available for PyMaterialXGenShader.GenOptions.addUpstreamDependencies

+

(bool) +Sets whether to include upstream dependencies +for the element to generate a shader for.

emitColorTransforms
-

No docstring available for PyMaterialXGenShader.GenOptions.emitColorTransforms

+

(bool) +Enable emitting colorspace transform code if a color management +system is defined. Defaults to True.

fileTextureVerticalFlip
-

No docstring available for PyMaterialXGenShader.GenOptions.fileTextureVerticalFlip

+

(bool) +If True the y-component of texture coordinates used for sampling +file textures will be flipped before sampling. This can be used if +file textures need to be flipped vertically to match the target’s +texture space convention. By default this option is False.

hwAmbientOcclusion
-

No docstring available for PyMaterialXGenShader.GenOptions.hwAmbientOcclusion

+

(bool) +Enables ambient occlusion rendering for HW shader targets. +Defaults to False.

hwImplicitBitangents
-

No docstring available for PyMaterialXGenShader.GenOptions.hwImplicitBitangents

+

(bool) +Calculate fallback bitangents from existing normals and tangents +inside the bitangent node.

hwMaxActiveLightSources
-

No docstring available for PyMaterialXGenShader.GenOptions.hwMaxActiveLightSources

+

(int) +Sets the maximum number of light sources that can +be active at once.

hwNormalizeUdimTexCoords
-

No docstring available for PyMaterialXGenShader.GenOptions.hwNormalizeUdimTexCoords

+

(bool) +Sets whether to transform texture coordinates to normalize +uv space when UDIMs images are bound to an image. Can be +enabled for when texture atlas generation is performed to +compress a set of UDIMs into a single normalized image for +hardware rendering.

hwShadowMap
-

No docstring available for PyMaterialXGenShader.GenOptions.hwShadowMap

+

(bool) +Enables shadow mapping for HW shader targets. +Defaults to False.

hwSpecularEnvironmentMethod
-

No docstring available for PyMaterialXGenShader.GenOptions.hwSpecularEnvironmentMethod

+

(HwSpecularEnvironmentMethod) +Sets the method to use for specular environment lighting +for HW shader targets.

hwSrgbEncodeOutput
-

No docstring available for PyMaterialXGenShader.GenOptions.hwSrgbEncodeOutput

+

(bool) +Enables an sRGB encoding for the color output on HW shader targets. +Defaults to False.

hwTransparency
-

No docstring available for PyMaterialXGenShader.GenOptions.hwTransparency

+

(bool) +Sets if transparency is needed or not for HW shaders. +If a surface shader has potential of being transparent +this must be set to True, otherwise no transparency +code fragments will be generated for the shader and +the surface will be fully opaque.

hwWriteAlbedoTable
-

No docstring available for PyMaterialXGenShader.GenOptions.hwWriteAlbedoTable

+

(bool) +Enables the writing of a directional albedo table. +Defaults to False.

hwWriteDepthMoments
-

No docstring available for PyMaterialXGenShader.GenOptions.hwWriteDepthMoments

+

(bool) +Enables the writing of depth moments for HW shader targets. +Defaults to False.

hwWriteEnvPrefilter
-

No docstring available for PyMaterialXGenShader.GenOptions.hwWriteEnvPrefilter

+

(bool) +Enables the generation of a prefiltered environment map. +Defaults to False.

libraryPrefix
-

No docstring available for PyMaterialXGenShader.GenOptions.libraryPrefix

+

(str) +The standard library prefix, which will be applied to +calls to emitLibraryInclude() during code generation. +Defaults to 'libraries'.

shaderInterfaceType
-

No docstring available for PyMaterialXGenShader.GenOptions.shaderInterfaceType

+

(ShaderInterfaceType) +Sets the type of shader interface to be generated.

targetColorSpaceOverride
-

No docstring available for PyMaterialXGenShader.GenOptions.targetColorSpaceOverride

+

(str) +An optional override for the target color space. +Shader fragments will be generated to transform +input values and textures into this color space.

targetDistanceUnit
-

No docstring available for PyMaterialXGenShader.GenOptions.targetDistanceUnit

+

(str) +Define the target distance unit. +Shader fragments will be generated to transform +input distance values to the given unit.

diff --git a/generated/PyMaterialXGenShader.GenUserData.html b/generated/PyMaterialXGenShader.GenUserData.html index bcba176..db6f7d5 100644 --- a/generated/PyMaterialXGenShader.GenUserData.html +++ b/generated/PyMaterialXGenShader.GenUserData.html @@ -39,6 +39,12 @@

PyMaterialXGenShader.GenUserData class GenUserData

Bases: pybind11_object

+

Base class for custom user data needed during shader generation.

+
+
See:
+

https://materialx.org/docs/api/class_gen_user_data.html

+
+

Methods

diff --git a/generated/PyMaterialXGenShader.HwResourceBindingContext.html b/generated/PyMaterialXGenShader.HwResourceBindingContext.html index 587d650..79d644a 100644 --- a/generated/PyMaterialXGenShader.HwResourceBindingContext.html +++ b/generated/PyMaterialXGenShader.HwResourceBindingContext.html @@ -39,6 +39,12 @@

PyMaterialXGenShader.HwResourceBindingContext class HwResourceBindingContext

Bases: GenUserData

+

Class representing a context for resource binding for hardware resources.

+
+
See:
+

https://materialx.org/docs/api/class_hw_resource_binding_context.html

+
+

Methods

diff --git a/generated/PyMaterialXGenShader.HwShaderGenerator.html b/generated/PyMaterialXGenShader.HwShaderGenerator.html index ddbcb09..71c264e 100644 --- a/generated/PyMaterialXGenShader.HwShaderGenerator.html +++ b/generated/PyMaterialXGenShader.HwShaderGenerator.html @@ -39,6 +39,12 @@

PyMaterialXGenShader.HwShaderGenerator class HwShaderGenerator

Bases: ShaderGenerator

+

Base class for shader generators targeting HW rendering.

+
+
See:
+

https://materialx.org/docs/api/class_hw_shader_generator.html

+
+

Methods

diff --git a/generated/PyMaterialXGenShader.HwSpecularEnvironmentMethod.html b/generated/PyMaterialXGenShader.HwSpecularEnvironmentMethod.html index 41592b8..30b3acb 100644 --- a/generated/PyMaterialXGenShader.HwSpecularEnvironmentMethod.html +++ b/generated/PyMaterialXGenShader.HwSpecularEnvironmentMethod.html @@ -39,10 +39,13 @@

PyMaterialXGenShader.HwSpecularEnvironmentMethod class HwSpecularEnvironmentMethod

Bases: pybind11_object

+

Method to use for specular environment lighting

Members:

-

SPECULAR_ENVIRONMENT_PREFILTER

-

SPECULAR_ENVIRONMENT_FIS

-

SPECULAR_ENVIRONMENT_NONE

+
+

SPECULAR_ENVIRONMENT_PREFILTER : Use pre-filtered environment maps for specular environment/indirect lighting.

+

SPECULAR_ENVIRONMENT_FIS : Use Filtered Importance Sampling for specular environment/indirect lighting.

+

SPECULAR_ENVIRONMENT_NONE : Do not use specular environment maps.

+

Methods

@@ -56,32 +59,27 @@

Properties
SPECULAR_ENVIRONMENT_FIS = <HwSpecularEnvironmentMethod.SPECULAR_ENVIRONMENT_FIS: 1>
-

No docstring available for PyMaterialXGenShader.HwSpecularEnvironmentMethod.SPECULAR_ENVIRONMENT_FIS

-
+
SPECULAR_ENVIRONMENT_NONE = <HwSpecularEnvironmentMethod.SPECULAR_ENVIRONMENT_NONE: 0>
-

No docstring available for PyMaterialXGenShader.HwSpecularEnvironmentMethod.SPECULAR_ENVIRONMENT_NONE

-
+
SPECULAR_ENVIRONMENT_PREFILTER = <HwSpecularEnvironmentMethod.SPECULAR_ENVIRONMENT_PREFILTER: 2>
-

No docstring available for PyMaterialXGenShader.HwSpecularEnvironmentMethod.SPECULAR_ENVIRONMENT_PREFILTER

-
+
name
-

No docstring available for PyMaterialXGenShader.HwSpecularEnvironmentMethod.name

-
+
value
-

No docstring available for PyMaterialXGenShader.HwSpecularEnvironmentMethod.value

-
+
diff --git a/generated/PyMaterialXGenShader.Shader.html b/generated/PyMaterialXGenShader.Shader.html index 87bd00b..0e292f1 100644 --- a/generated/PyMaterialXGenShader.Shader.html +++ b/generated/PyMaterialXGenShader.Shader.html @@ -39,6 +39,17 @@

PyMaterialXGenShader.Shader class Shader

Bases: pybind11_object

+

Class containing all data needed during shader generation.

+

After generation is completed it will contain the resulting source code +emitted by shader generators.

+

The class contains a default implementation using a single shader stage. +Derived shaders can override this, as well as overriding all methods +that add code to the shader.

+
+
See:
+

https://materialx.org/docs/api/class_shader.html

+
+

Methods

diff --git a/generated/PyMaterialXGenShader.ShaderGenerator.html b/generated/PyMaterialXGenShader.ShaderGenerator.html index e4d449e..efc49bd 100644 --- a/generated/PyMaterialXGenShader.ShaderGenerator.html +++ b/generated/PyMaterialXGenShader.ShaderGenerator.html @@ -39,6 +39,15 @@

PyMaterialXGenShader.ShaderGenerator class ShaderGenerator

Bases: pybind11_object

+

Base class for shader generators.

+

All third-party shader generators should derive from this class.

+

Derived classes should use DECLARE_SHADER_GENERATOR / DEFINE_SHADER_GENERATOR +in their declaration / definition, and register with the Registry class.

+
+
See:
+

https://materialx.org/docs/api/class_shader_generator.html

+
+

Methods

diff --git a/generated/PyMaterialXGenShader.ShaderInterfaceType.html b/generated/PyMaterialXGenShader.ShaderInterfaceType.html index 9fe1b47..4a8b2e2 100644 --- a/generated/PyMaterialXGenShader.ShaderInterfaceType.html +++ b/generated/PyMaterialXGenShader.ShaderInterfaceType.html @@ -39,9 +39,12 @@

PyMaterialXGenShader.ShaderInterfaceType class ShaderInterfaceType

Bases: pybind11_object

+

Type of shader interface to be generated

Members:

-

SHADER_INTERFACE_COMPLETE

-

SHADER_INTERFACE_REDUCED

+
+

SHADER_INTERFACE_COMPLETE : Create a complete interface with uniforms for all editable inputs on all nodes used by the shader. This interface makes the shader fully editable by value without requiring any rebuilds. This is the default interface type.

+

SHADER_INTERFACE_REDUCED : Create a reduced interface with uniforms only for the inputs that has been declared in the shaders nodedef interface. If values on other inputs are changed the shader needs to be rebuilt.

+

Methods

@@ -55,26 +58,22 @@

Properties
SHADER_INTERFACE_COMPLETE = <ShaderInterfaceType.SHADER_INTERFACE_COMPLETE: 0>
-

No docstring available for PyMaterialXGenShader.ShaderInterfaceType.SHADER_INTERFACE_COMPLETE

-
+
SHADER_INTERFACE_REDUCED = <ShaderInterfaceType.SHADER_INTERFACE_REDUCED: 1>
-

No docstring available for PyMaterialXGenShader.ShaderInterfaceType.SHADER_INTERFACE_REDUCED

-
+
name
-

No docstring available for PyMaterialXGenShader.ShaderInterfaceType.name

-
+
value
-

No docstring available for PyMaterialXGenShader.ShaderInterfaceType.value

-
+
diff --git a/generated/PyMaterialXGenShader.ShaderPort.html b/generated/PyMaterialXGenShader.ShaderPort.html index ab5be14..f478d64 100644 --- a/generated/PyMaterialXGenShader.ShaderPort.html +++ b/generated/PyMaterialXGenShader.ShaderPort.html @@ -39,6 +39,12 @@

PyMaterialXGenShader.ShaderPort class ShaderPort

Bases: pybind11_object

+

An input or output port on a ShaderNode.

+
+
See:
+

https://materialx.org/docs/api/class_shader_port.html

+
+

Methods

diff --git a/generated/PyMaterialXGenShader.ShaderPortPredicate.html b/generated/PyMaterialXGenShader.ShaderPortPredicate.html index 607f7e3..77a3786 100644 --- a/generated/PyMaterialXGenShader.ShaderPortPredicate.html +++ b/generated/PyMaterialXGenShader.ShaderPortPredicate.html @@ -39,6 +39,7 @@

PyMaterialXGenShader.ShaderPortPredicate class ShaderPortPredicate

Bases: pybind11_object

+

A function predicate taking a ShaderPort and returning a bool.

Methods

diff --git a/generated/PyMaterialXGenShader.ShaderStage.html b/generated/PyMaterialXGenShader.ShaderStage.html index e7154aa..82c98b8 100644 --- a/generated/PyMaterialXGenShader.ShaderStage.html +++ b/generated/PyMaterialXGenShader.ShaderStage.html @@ -39,6 +39,12 @@

PyMaterialXGenShader.ShaderStage class ShaderStage

Bases: pybind11_object

+

A shader stage, containing the state and resulting source code for the stage.

+
+
See:
+

https://materialx.org/docs/api/class_shader_stage.html

+
+

Methods

diff --git a/generated/PyMaterialXGenShader.ShaderTranslator.html b/generated/PyMaterialXGenShader.ShaderTranslator.html index c327638..c05d646 100644 --- a/generated/PyMaterialXGenShader.ShaderTranslator.html +++ b/generated/PyMaterialXGenShader.ShaderTranslator.html @@ -39,6 +39,12 @@

PyMaterialXGenShader.ShaderTranslator class ShaderTranslator

Bases: pybind11_object

+

A helper class for translating content between shading models.

+
+
See:
+

https://materialx.org/docs/api/class_shader_translator.html

+
+

Methods

diff --git a/generated/PyMaterialXGenShader.TypeDesc.html b/generated/PyMaterialXGenShader.TypeDesc.html index 37df405..e768a55 100644 --- a/generated/PyMaterialXGenShader.TypeDesc.html +++ b/generated/PyMaterialXGenShader.TypeDesc.html @@ -39,6 +39,22 @@

PyMaterialXGenShader.TypeDesc class TypeDesc

Bases: pybind11_object

+

A type descriptor for MaterialX data types.

+

All types need to have a type descriptor registered in order for shader generators +to know about the type. It can be used for type comparisons as well as getting more +information about the type. Type descriptors for all standard library data types are +registered by default and can be accessed from the Type namespace, e.g. Type::FLOAT.

+

To register custom types use the macro TYPEDESC_DEFINE_TYPE to define it in a header +and the macro TYPEDESC_REGISTER_TYPE to register it in the type registry. Registration +must be done in order to access the type’s name later using getName() and to find the +type by name using TypeDesc.get().

+

The class is a POD type of 64-bits and can efficiently be stored and passed by value. +Type compare operations and hash operations are done using a precomputed hash value.

+
+
See:
+

https://materialx.org/docs/api/class_type_desc.html

+
+

Methods

diff --git a/generated/PyMaterialXGenShader.UnitSystem.html b/generated/PyMaterialXGenShader.UnitSystem.html index 553935e..b08e78d 100644 --- a/generated/PyMaterialXGenShader.UnitSystem.html +++ b/generated/PyMaterialXGenShader.UnitSystem.html @@ -39,6 +39,12 @@

PyMaterialXGenShader.UnitSystem class UnitSystem

Bases: pybind11_object

+

Base unit system support.

+
+
See:
+

https://materialx.org/docs/api/class_unit_system.html

+
+

Methods

diff --git a/generated/PyMaterialXGenShader.UnitTransform.html b/generated/PyMaterialXGenShader.UnitTransform.html index ae1dfc2..fa8daa8 100644 --- a/generated/PyMaterialXGenShader.UnitTransform.html +++ b/generated/PyMaterialXGenShader.UnitTransform.html @@ -39,6 +39,12 @@

PyMaterialXGenShader.UnitTransform class UnitTransform

Bases: pybind11_object

+

Structure that represents unit transform information.

+
+
See:
+

https://materialx.org/docs/api/struct_unit_transform.html

+
+

Methods

@@ -52,26 +58,22 @@

Properties
sourceUnit
-

No docstring available for PyMaterialXGenShader.UnitTransform.sourceUnit

-
+
targetUnit
-

No docstring available for PyMaterialXGenShader.UnitTransform.targetUnit

-
+
type
-

No docstring available for PyMaterialXGenShader.UnitTransform.type

-
+
unitType
-

No docstring available for PyMaterialXGenShader.UnitTransform.unitType

-
+
diff --git a/generated/PyMaterialXGenShader.VariableBlock.html b/generated/PyMaterialXGenShader.VariableBlock.html index 7b16518..9703e29 100644 --- a/generated/PyMaterialXGenShader.VariableBlock.html +++ b/generated/PyMaterialXGenShader.VariableBlock.html @@ -39,6 +39,12 @@

PyMaterialXGenShader.VariableBlock class VariableBlock

Bases: pybind11_object

+

A block of variables in a shader stage.

+
+
See:
+

https://materialx.org/docs/api/class_variable_block.html

+
+

Methods

diff --git a/generated/PyMaterialXGenShader.html b/generated/PyMaterialXGenShader.html index 28dcabc..f114fab 100644 --- a/generated/PyMaterialXGenShader.html +++ b/generated/PyMaterialXGenShader.html @@ -41,67 +41,67 @@

Classes

- + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - +

ApplicationVariableHandler

A function to allow for handling of application variables for a given node.

ColorManagementSystem

Abstract base class for color management systems.

ColorSpaceTransform

Structure that represents color space transform information.

DefaultColorManagementSystem

Class for a default color management system.

GenContext

A context class for shader generation.

GenOptions

Class holding options to configure shader generation.

GenUserData

Base class for custom user data needed during shader generation.

HwResourceBindingContext

Class representing a context for resource binding for hardware resources.

HwShaderGenerator

Base class for shader generators targeting HW rendering.

HwSpecularEnvironmentMethod

Members:

Method to use for specular environment lighting

Shader

Class containing all data needed during shader generation.

ShaderGenerator

Base class for shader generators.

ShaderInterfaceType

Members:

Type of shader interface to be generated

ShaderPort

An input or output port on a ShaderNode.

ShaderPortPredicate

A function predicate taking a ShaderPort and returning a bool.

ShaderStage

A shader stage, containing the state and resulting source code for the stage.

ShaderTranslator

A helper class for translating content between shading models.

TypeDesc

A type descriptor for MaterialX data types.

UnitSystem

Base unit system support.

UnitTransform

Structure that represents unit transform information.

VariableBlock

A block of variables in a shader stage.
diff --git a/generated/PyMaterialXRender.BaseType.html b/generated/PyMaterialXRender.BaseType.html index da024ff..ecfffee 100644 --- a/generated/PyMaterialXRender.BaseType.html +++ b/generated/PyMaterialXRender.BaseType.html @@ -39,11 +39,19 @@

PyMaterialXRender.BaseType class BaseType

Bases: pybind11_object

+

Enumeration of Image base types.

+
+
See:
+

https://materialx.org/docs/api/class_image.html#pub-types

+
+

Members:

-

UINT8

-

UINT16

-

HALF

-

FLOAT

+
+

UINT8 : 8-bit unsigned integer number.

+

UINT16 : 16-bit unsigned integer number.

+

HALF : Half-precision floating-point number.

+

FLOAT : Full-precision floating-point number.

+

Methods

@@ -57,38 +65,32 @@

Properties
FLOAT = <BaseType.FLOAT: 5>
-

No docstring available for PyMaterialXRender.BaseType.FLOAT

-
+
HALF = <BaseType.HALF: 4>
-

No docstring available for PyMaterialXRender.BaseType.HALF

-
+
UINT16 = <BaseType.UINT16: 2>
-

No docstring available for PyMaterialXRender.BaseType.UINT16

-
+
UINT8 = <BaseType.UINT8: 0>
-

No docstring available for PyMaterialXRender.BaseType.UINT8

-
+
name
-

No docstring available for PyMaterialXRender.BaseType.name

-
+
value
-

No docstring available for PyMaterialXRender.BaseType.value

-
+
diff --git a/generated/PyMaterialXRender.Camera.html b/generated/PyMaterialXRender.Camera.html index 9383d91..cd16e73 100644 --- a/generated/PyMaterialXRender.Camera.html +++ b/generated/PyMaterialXRender.Camera.html @@ -39,6 +39,13 @@

PyMaterialXRender.Camera class Camera

Bases: pybind11_object

+

A simple camera class, supporting transform matrices and arcball +functionality for object-viewing applications.

+
+
See:
+

https://materialx.org/docs/api/class_camera.html

+
+

Methods

diff --git a/generated/PyMaterialXRender.CgltfLoader.html b/generated/PyMaterialXRender.CgltfLoader.html index f2e06b7..1db8cab 100644 --- a/generated/PyMaterialXRender.CgltfLoader.html +++ b/generated/PyMaterialXRender.CgltfLoader.html @@ -39,6 +39,12 @@

PyMaterialXRender.CgltfLoader class CgltfLoader

Bases: GeometryLoader

+

Wrapper for loader to read in GLTF files using the Cgltf library.

+
+
See:
+

https://materialx.org/docs/api/class_cgltf_loader.html

+
+

Methods

diff --git a/generated/PyMaterialXRender.ExceptionRenderError.html b/generated/PyMaterialXRender.ExceptionRenderError.html index 162c633..f2ed5de 100644 --- a/generated/PyMaterialXRender.ExceptionRenderError.html +++ b/generated/PyMaterialXRender.ExceptionRenderError.html @@ -39,6 +39,14 @@

PyMaterialXRender.ExceptionRenderError exception ExceptionRenderError

Bases: Exception

+

A type of exception that is raised when a rendering operation fails.

+

Optionally stores an additional error log, which can be used to +store and retrieve shader compilation errors.

+
+
See:
+

https://materialx.org/docs/api/class_exception_render_error.html

+
+
diff --git a/generated/PyMaterialXRender.GeometryHandler.html b/generated/PyMaterialXRender.GeometryHandler.html index 5f565ad..793d1b7 100644 --- a/generated/PyMaterialXRender.GeometryHandler.html +++ b/generated/PyMaterialXRender.GeometryHandler.html @@ -39,6 +39,13 @@

PyMaterialXRender.GeometryHandler class GeometryHandler

Bases: pybind11_object

+

Class which holds a set of geometry loaders.

+

Each loader is associated with a given set of file extensions.

+
+
See:
+

https://materialx.org/docs/api/class_geometry_handler.html

+
+

Methods

diff --git a/generated/PyMaterialXRender.GeometryLoader.html b/generated/PyMaterialXRender.GeometryLoader.html index bb34629..93fe598 100644 --- a/generated/PyMaterialXRender.GeometryLoader.html +++ b/generated/PyMaterialXRender.GeometryLoader.html @@ -39,6 +39,13 @@

PyMaterialXRender.GeometryLoader class GeometryLoader

Bases: pybind11_object

+

Base class representing a geometry loader.

+

A loader can be associated with one or more file extensions.

+
+
See:
+

https://materialx.org/docs/api/class_geometry_loader.html

+
+

Methods

diff --git a/generated/PyMaterialXRender.Image.html b/generated/PyMaterialXRender.Image.html index 1ee7530..e43d7b2 100644 --- a/generated/PyMaterialXRender.Image.html +++ b/generated/PyMaterialXRender.Image.html @@ -39,6 +39,12 @@

PyMaterialXRender.Image class Image

Bases: pybind11_object

+

Class representing an image in system memory.

+
+
See:
+

https://materialx.org/docs/api/class_image.html

+
+

Methods

diff --git a/generated/PyMaterialXRender.ImageBufferDeallocator.html b/generated/PyMaterialXRender.ImageBufferDeallocator.html index 5d3cd3f..7484aef 100644 --- a/generated/PyMaterialXRender.ImageBufferDeallocator.html +++ b/generated/PyMaterialXRender.ImageBufferDeallocator.html @@ -39,6 +39,7 @@

PyMaterialXRender.ImageBufferDeallocator class ImageBufferDeallocator

Bases: pybind11_object

+

A function to perform image buffer deallocation.

Methods

diff --git a/generated/PyMaterialXRender.ImageHandler.html b/generated/PyMaterialXRender.ImageHandler.html index d54c971..8762811 100644 --- a/generated/PyMaterialXRender.ImageHandler.html +++ b/generated/PyMaterialXRender.ImageHandler.html @@ -39,6 +39,16 @@

PyMaterialXRender.ImageHandler class ImageHandler

Bases: pybind11_object

+

Base image handler class.

+

Keeps track of images which are loaded from disk via supplied ImageLoader.

+

Derived classes are responsible for determinining how to perform the logic +for “binding” of these resources for a given target (such as a given +shading language).

+
+
See:
+

https://materialx.org/docs/api/class_image_handler.html

+
+

Methods

@@ -104,7 +114,7 @@

Methods
-acquireImage(self: ImageHandler, filePath: FilePath, defaultColor: Color4 = <Color4 object at 0x106d8af70>) → Image
+acquireImage(self: ImageHandler, filePath: FilePath, defaultColor: Color4 = <Color4 object at 0x107d90d30>) → Image
diff --git a/generated/PyMaterialXRender.ImageLoader.html b/generated/PyMaterialXRender.ImageLoader.html index dcbcc87..a38582c 100644 --- a/generated/PyMaterialXRender.ImageLoader.html +++ b/generated/PyMaterialXRender.ImageLoader.html @@ -39,6 +39,12 @@

PyMaterialXRender.ImageLoader class ImageLoader

Bases: pybind11_object

+

Abstract base class for file-system image loaders.

+
+
See:
+

https://materialx.org/docs/api/class_image_loader.html

+
+

Methods

diff --git a/generated/PyMaterialXRender.ImageSamplingProperties.html b/generated/PyMaterialXRender.ImageSamplingProperties.html index 0bc8f9a..2ea5b74 100644 --- a/generated/PyMaterialXRender.ImageSamplingProperties.html +++ b/generated/PyMaterialXRender.ImageSamplingProperties.html @@ -39,6 +39,12 @@

PyMaterialXRender.ImageSamplingProperties class ImageSamplingProperties

Bases: pybind11_object

+

Interface to describe sampling properties for images.

+
+
See:
+

https://materialx.org/docs/api/class_image_sampling_properties.html

+
+

Methods

@@ -52,26 +58,22 @@

Properties
defaultColor
-

No docstring available for PyMaterialXRender.ImageSamplingProperties.defaultColor

-
+
filterType
-

No docstring available for PyMaterialXRender.ImageSamplingProperties.filterType

-
+
uaddressMode
-

No docstring available for PyMaterialXRender.ImageSamplingProperties.uaddressMode

-
+
vaddressMode
-

No docstring available for PyMaterialXRender.ImageSamplingProperties.vaddressMode

-
+
diff --git a/generated/PyMaterialXRender.LightHandler.html b/generated/PyMaterialXRender.LightHandler.html index cb26b7c..6d888d5 100644 --- a/generated/PyMaterialXRender.LightHandler.html +++ b/generated/PyMaterialXRender.LightHandler.html @@ -39,6 +39,12 @@

PyMaterialXRender.LightHandler class LightHandler

Bases: pybind11_object

+

Utility light handler for creating and providing light data for shader binding.

+
+
See:
+

https://materialx.org/docs/api/class_light_handler.html

+
+

Methods

diff --git a/generated/PyMaterialXRender.Mesh.html b/generated/PyMaterialXRender.Mesh.html index 9e528d2..809be44 100644 --- a/generated/PyMaterialXRender.Mesh.html +++ b/generated/PyMaterialXRender.Mesh.html @@ -39,6 +39,12 @@

PyMaterialXRender.Mesh class Mesh

Bases: pybind11_object

+

Container for mesh data.

+
+
See:
+

https://materialx.org/docs/api/class_mesh.html

+
+

Methods

diff --git a/generated/PyMaterialXRender.MeshPartition.html b/generated/PyMaterialXRender.MeshPartition.html index cc76d6d..f658ed7 100644 --- a/generated/PyMaterialXRender.MeshPartition.html +++ b/generated/PyMaterialXRender.MeshPartition.html @@ -39,6 +39,13 @@

PyMaterialXRender.MeshPartition class MeshPartition

Bases: pybind11_object

+

Class that describes a sub-region of a mesh using vertex indexing.

+

Note that a face is considered to be a triangle.

+
+
See:
+

https://materialx.org/docs/api/class_mesh_partition.html

+
+

Methods

diff --git a/generated/PyMaterialXRender.MeshStream.html b/generated/PyMaterialXRender.MeshStream.html index c40a714..895d670 100644 --- a/generated/PyMaterialXRender.MeshStream.html +++ b/generated/PyMaterialXRender.MeshStream.html @@ -39,6 +39,12 @@

PyMaterialXRender.MeshStream class MeshStream

Bases: pybind11_object

+

Class to represent a mesh data stream.

+
+
See:
+

https://materialx.org/docs/api/class_mesh_stream.html

+
+

Methods

diff --git a/generated/PyMaterialXRender.ShaderRenderer.html b/generated/PyMaterialXRender.ShaderRenderer.html index 6224c0c..256aca8 100644 --- a/generated/PyMaterialXRender.ShaderRenderer.html +++ b/generated/PyMaterialXRender.ShaderRenderer.html @@ -39,6 +39,12 @@

PyMaterialXRender.ShaderRenderer class ShaderRenderer

Bases: pybind11_object

+

Base class for renderers that generate shader code to produce images.

+
+
See:
+

https://materialx.org/docs/api/class_shader_renderer.html

+
+

Methods

diff --git a/generated/PyMaterialXRender.StbImageLoader.html b/generated/PyMaterialXRender.StbImageLoader.html index 208bf2b..5b3c0a8 100644 --- a/generated/PyMaterialXRender.StbImageLoader.html +++ b/generated/PyMaterialXRender.StbImageLoader.html @@ -39,6 +39,12 @@

PyMaterialXRender.StbImageLoader class StbImageLoader

Bases: ImageLoader

+

Stb image file loader.

+
+
See:
+

https://materialx.org/docs/api/class_stb_image_loader.html

+
+

Methods

diff --git a/generated/PyMaterialXRender.TinyObjLoader.html b/generated/PyMaterialXRender.TinyObjLoader.html index 5c258f0..a339f19 100644 --- a/generated/PyMaterialXRender.TinyObjLoader.html +++ b/generated/PyMaterialXRender.TinyObjLoader.html @@ -39,6 +39,12 @@

PyMaterialXRender.TinyObjLoader class TinyObjLoader

Bases: GeometryLoader

+

Wrapper for geometry loader to read in OBJ files using the TinyObj library.

+
+
See:
+

https://materialx.org/docs/api/class_tiny_obj_loader.html

+
+

Methods

diff --git a/generated/PyMaterialXRender.html b/generated/PyMaterialXRender.html index c334e7b..d4d6a48 100644 --- a/generated/PyMaterialXRender.html +++ b/generated/PyMaterialXRender.html @@ -41,55 +41,55 @@

Classes

- + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - +

BaseType

Members:

Enumeration of Image base types.

Camera

A simple camera class, supporting transform matrices and arcball functionality for object-viewing applications.

CgltfLoader

Wrapper for loader to read in GLTF files using the Cgltf library.

GeometryHandler

Class which holds a set of geometry loaders.

GeometryLoader

Base class representing a geometry loader.

Image

Class representing an image in system memory.

ImageBufferDeallocator

A function to perform image buffer deallocation.

ImageHandler

Base image handler class.

ImageLoader

Abstract base class for file-system image loaders.

ImageSamplingProperties

Interface to describe sampling properties for images.

LightHandler

Utility light handler for creating and providing light data for shader binding.

Mesh

Container for mesh data.

MeshPartition

Class that describes a sub-region of a mesh using vertex indexing.

MeshStream

Class to represent a mesh data stream.

ShaderRenderer

Base class for renderers that generate shader code to produce images.

StbImageLoader

Stb image file loader.

TinyObjLoader

Wrapper for geometry loader to read in OBJ files using the TinyObj library.
@@ -99,7 +99,7 @@

Exception Types

ExceptionRenderError

-

+

A type of exception that is raised when a rendering operation fails.

diff --git a/generated/PyMaterialXRenderGlsl.GLTextureHandler.html b/generated/PyMaterialXRenderGlsl.GLTextureHandler.html index 44321ca..0033a49 100644 --- a/generated/PyMaterialXRenderGlsl.GLTextureHandler.html +++ b/generated/PyMaterialXRenderGlsl.GLTextureHandler.html @@ -39,6 +39,12 @@

PyMaterialXRenderGlsl.GLTextureHandler class GLTextureHandler

Bases: ImageHandler

+

An OpenGL texture handler class.

+
+
See:
+

https://materialx.org/docs/api/class_g_l_texture_handler.html

+
+

Methods

diff --git a/generated/PyMaterialXRenderGlsl.GlslProgram.html b/generated/PyMaterialXRenderGlsl.GlslProgram.html index 2729c37..9101123 100644 --- a/generated/PyMaterialXRenderGlsl.GlslProgram.html +++ b/generated/PyMaterialXRenderGlsl.GlslProgram.html @@ -39,6 +39,15 @@

PyMaterialXRenderGlsl.GlslProgram class GlslProgram

Bases: pybind11_object

+

A class representing an executable GLSL program.

+

There are two main interfaces which can be used: +one which takes in a HwShader and +one which allows for explicit setting of shader stage code.

+
+
See:
+

https://materialx.org/docs/api/class_glsl_program.html

+
+

Methods

@@ -121,14 +130,12 @@

Properties
UNDEFINED_OPENGL_PROGRAM_LOCATION = -1
-

No docstring available for PyMaterialXRenderGlsl.GlslProgram.UNDEFINED_OPENGL_PROGRAM_LOCATION

-
+
UNDEFINED_OPENGL_RESOURCE_ID = 0
-

No docstring available for PyMaterialXRenderGlsl.GlslProgram.UNDEFINED_OPENGL_RESOURCE_ID

-
+
diff --git a/generated/PyMaterialXRenderGlsl.GlslRenderer.html b/generated/PyMaterialXRenderGlsl.GlslRenderer.html index 826d2f0..c6c287a 100644 --- a/generated/PyMaterialXRenderGlsl.GlslRenderer.html +++ b/generated/PyMaterialXRenderGlsl.GlslRenderer.html @@ -39,6 +39,26 @@

PyMaterialXRenderGlsl.GlslRenderer class GlslRenderer

Bases: ShaderRenderer

+

Helper class for rendering generated GLSL code to produce images.

+

There are two main interfaces which can be used: +one which takes in a HwShader and +one which allows for explicit setting of shader stage code.

+
+
The main services provided are:
    +

  • Validation: All shader stages are compiled and atteched to a GLSL shader program.

    • +

  • Introspection: The compiled shader program is examined for uniforms and attributes.

    • +

  • Binding: Uniforms and attributes which match the predefined variables generated the GLSL code generator +will have values assigned to this. This includes matrices, attribute streams, and textures.

    • +

  • Rendering: The program with bound inputs will be used to drawing geometry to an offscreen buffer. +An interface is provided to save this offscreen buffer to disk using an externally defined image handler.

    • +
+
+
+
+
See:
+

https://materialx.org/docs/api/class_glsl_renderer.html

+
+

Methods

diff --git a/generated/PyMaterialXRenderGlsl.Input.html b/generated/PyMaterialXRenderGlsl.Input.html index b259a8b..e98249d 100644 --- a/generated/PyMaterialXRenderGlsl.Input.html +++ b/generated/PyMaterialXRenderGlsl.Input.html @@ -39,6 +39,15 @@

PyMaterialXRenderGlsl.Input class Input

Bases: pybind11_object

+

Structure to hold information about program inputs.

+

The structure is populated by directly scanning the program so may not contain +some inputs listed on any associated HwShader as those inputs may have been +optimized out if they are unused.

+
+
See:
+

https://materialx.org/docs/api/struct_glsl_program_1_1_input.html

+
+

Methods

@@ -52,50 +61,42 @@

Properties
INVALID_OPENGL_TYPE = -1
-

No docstring available for PyMaterialXRenderGlsl.Input.INVALID_OPENGL_TYPE

-
+
gltype
-

No docstring available for PyMaterialXRenderGlsl.Input.gltype

-
+
isConstant
-

No docstring available for PyMaterialXRenderGlsl.Input.isConstant

-
+
location
-

No docstring available for PyMaterialXRenderGlsl.Input.location

-
+
path
-

No docstring available for PyMaterialXRenderGlsl.Input.path

-
+
size
-

No docstring available for PyMaterialXRenderGlsl.Input.size

-
+
typeString
-

No docstring available for PyMaterialXRenderGlsl.Input.typeString

-
+
value
-

No docstring available for PyMaterialXRenderGlsl.Input.value

-
+
diff --git a/generated/PyMaterialXRenderGlsl.TextureBaker.html b/generated/PyMaterialXRenderGlsl.TextureBaker.html index 41d6e5d..4f6b16e 100644 --- a/generated/PyMaterialXRenderGlsl.TextureBaker.html +++ b/generated/PyMaterialXRenderGlsl.TextureBaker.html @@ -39,6 +39,13 @@

PyMaterialXRenderGlsl.TextureBaker class TextureBaker

Bases: GlslRenderer

+

An implementation of TextureBaker +based on GLSL shader generation.

+
+
See:
+

https://materialx.org/docs/api/class_texture_baker_glsl.html

+
+

Methods

diff --git a/generated/PyMaterialXRenderGlsl.html b/generated/PyMaterialXRenderGlsl.html index db28f7a..3001417 100644 --- a/generated/PyMaterialXRenderGlsl.html +++ b/generated/PyMaterialXRenderGlsl.html @@ -41,19 +41,19 @@

Classes

- + - + - + - + - +

GLTextureHandler

An OpenGL texture handler class.

GlslProgram

A class representing an executable GLSL program.

GlslRenderer

Helper class for rendering generated GLSL code to produce images.

Input

Structure to hold information about program inputs.

TextureBaker

An implementation of TextureBaker based on GLSL shader generation.
diff --git a/generated/PyMaterialXRenderMsl.Input.html b/generated/PyMaterialXRenderMsl.Input.html index 4c077b0..05fe1e5 100644 --- a/generated/PyMaterialXRenderMsl.Input.html +++ b/generated/PyMaterialXRenderMsl.Input.html @@ -39,6 +39,10 @@

PyMaterialXRenderMsl.Input class Input

Bases: pybind11_object

+

Structure to hold information about program inputs.

+

The structure is populated by directly scanning the program so may not contain +some inputs listed on any associated HwShader as those inputs may have been +optimized out if they are unused.

Methods

@@ -52,38 +56,32 @@

Properties
isConstant
-

No docstring available for PyMaterialXRenderMsl.Input.isConstant

-
+
location
-

No docstring available for PyMaterialXRenderMsl.Input.location

-
+
path
-

No docstring available for PyMaterialXRenderMsl.Input.path

-
+
size
-

No docstring available for PyMaterialXRenderMsl.Input.size

-
+
typeString
-

No docstring available for PyMaterialXRenderMsl.Input.typeString

-
+
value
-

No docstring available for PyMaterialXRenderMsl.Input.value

-
+
diff --git a/generated/PyMaterialXRenderMsl.MetalTextureHandler.html b/generated/PyMaterialXRenderMsl.MetalTextureHandler.html index 9d7fedb..ebe2f5d 100644 --- a/generated/PyMaterialXRenderMsl.MetalTextureHandler.html +++ b/generated/PyMaterialXRenderMsl.MetalTextureHandler.html @@ -39,6 +39,7 @@

PyMaterialXRenderMsl.MetalTextureHandler class MetalTextureHandler

Bases: ImageHandler

+

A Metal texture handler class.

Methods

diff --git a/generated/PyMaterialXRenderMsl.MslProgram.html b/generated/PyMaterialXRenderMsl.MslProgram.html index b40a0de..c215ed9 100644 --- a/generated/PyMaterialXRenderMsl.MslProgram.html +++ b/generated/PyMaterialXRenderMsl.MslProgram.html @@ -39,6 +39,10 @@

PyMaterialXRenderMsl.MslProgram class MslProgram

Bases: pybind11_object

+

A class representing an executable MSL program.

+

There are two main interfaces which can be used: +one which takes in a HwShader and +one which allows for explicit setting of shader stage code.

Methods

diff --git a/generated/PyMaterialXRenderMsl.MslRenderer.html b/generated/PyMaterialXRenderMsl.MslRenderer.html index 965ff8c..32437c4 100644 --- a/generated/PyMaterialXRenderMsl.MslRenderer.html +++ b/generated/PyMaterialXRenderMsl.MslRenderer.html @@ -39,6 +39,21 @@

PyMaterialXRenderMsl.MslRenderer class MslRenderer

Bases: ShaderRenderer

+

Helper class for rendering generated MSL code to produce images.

+

There are two main interfaces which can be used: +one which takes in a HwShader and +one which allows for explicit setting of shader stage code.

+
+
The main services provided are:
    +

  • Validation: All shader stages are compiled and atteched to an MSL shader program.

    • +

  • Introspection: The compiled shader program is examined for uniforms and attributes.

    • +

  • Binding: Uniforms and attributes which match the predefined variables generated the MSL code generator +will have values assigned to this. This includes matrices, attribute streams, and textures.

    • +

  • Rendering: The program with bound inputs will be used to drawing geometry to an offscreen buffer. +An interface is provided to save this offscreen buffer to disk using an externally defined image handler.

    • +
+
+

Methods

diff --git a/generated/PyMaterialXRenderMsl.TextureBaker.html b/generated/PyMaterialXRenderMsl.TextureBaker.html index fb0be5c..a7438b9 100644 --- a/generated/PyMaterialXRenderMsl.TextureBaker.html +++ b/generated/PyMaterialXRenderMsl.TextureBaker.html @@ -38,6 +38,8 @@

PyMaterialXRenderMsl.TextureBaker class TextureBaker

Bases: MslRenderer

+

An implementation of TextureBaker +based on MSL shader generation.

Methods

diff --git a/generated/PyMaterialXRenderMsl.html b/generated/PyMaterialXRenderMsl.html index f94e7aa..d3f78d5 100644 --- a/generated/PyMaterialXRenderMsl.html +++ b/generated/PyMaterialXRenderMsl.html @@ -41,19 +41,19 @@

Classes

- + - + - + - + - +

Input

Structure to hold information about program inputs.

MetalTextureHandler

A Metal texture handler class.

MslProgram

A class representing an executable MSL program.

MslRenderer

Helper class for rendering generated MSL code to produce images.

TextureBaker

An implementation of TextureBaker based on MSL shader generation.
diff --git a/generated/PyMaterialXRenderOsl.OslRenderer.html b/generated/PyMaterialXRenderOsl.OslRenderer.html index 895ab03..e24ac47 100644 --- a/generated/PyMaterialXRenderOsl.OslRenderer.html +++ b/generated/PyMaterialXRenderOsl.OslRenderer.html @@ -39,6 +39,23 @@

PyMaterialXRenderOsl.OslRenderer class OslRenderer

Bases: ShaderRenderer

+

Helper class for rendering generated OSL code to produce images.

+
+
The main services provided are:
    +

  • Source code validation: Use of oslc to compile and test output results

    • +

  • Introspection check: None at this time.

    • +

  • Binding: None at this time.

    • +

  • Render validation: Use of testrender to output rendered images. +Assumes source compliation was success as it depends on the existence +of corresponding oso files.

    • +
+
+
+
+
See:
+

https://materialx.org/docs/api/class_osl_renderer.html

+
+

Methods

diff --git a/generated/PyMaterialXRenderOsl.html b/generated/PyMaterialXRenderOsl.html index 49c1e3d..dbeada9 100644 --- a/generated/PyMaterialXRenderOsl.html +++ b/generated/PyMaterialXRenderOsl.html @@ -41,7 +41,7 @@

Classes

- +

OslRenderer

Helper class for rendering generated OSL code to produce images.