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

__init__(*args, **kwargs)

captureImage(self, arg0)

compileOSL(self, arg0)

create(arg0, arg1, arg2)

createProgram(*args, **kwargs)

Overloaded function.

initialize(self[, renderContextHandle])

render(self)

setOslCompilerExecutable(self, arg0)

setOslIncludePath(self, arg0)

setOslOutputFilePath(self, arg0)

setOslShaderName(self, arg0)

setOslShaderOutput(self, arg0, arg1)

setOslTestRenderExecutable(self, arg0)

setOslTestRenderSceneTemplateFile(self, arg0)

setOslTestShadeExecutable(self, arg0)

setOslUtilityOSOPath(self, arg0)

setShaderParameterOverrides(self, arg0)

useTestRender(self, arg0)

validateInputs(self)

Properties

OSL_CLOSURE_COLOR_STRING = 'closure color'

Methods

__init__(*args, **kwargs)
captureImage(self: OslRenderer, arg0: Image) Image
compileOSL(self: OslRenderer, arg0: FilePath) None
static create(arg0: int, arg1: int, arg2: BaseType) OslRenderer
createProgram(*args, **kwargs)

Overloaded function.

  1. createProgram(self: PyMaterialXRenderOsl.OslRenderer, arg0: PyMaterialXGenShader.Shader) -> None

  2. createProgram(self: PyMaterialXRenderOsl.OslRenderer, arg0: dict[str, str]) -> None

initialize(self: OslRenderer, renderContextHandle: capsule = None) None
render(self: OslRenderer) None
setOslCompilerExecutable(self: OslRenderer, arg0: FilePath) None
setOslIncludePath(self: OslRenderer, arg0: FileSearchPath) None
setOslOutputFilePath(self: OslRenderer, arg0: FilePath) None
setOslShaderName(self: OslRenderer, arg0: str) None
setOslShaderOutput(self: OslRenderer, arg0: str, arg1: str) None
setOslTestRenderExecutable(self: OslRenderer, arg0: FilePath) None
setOslTestRenderSceneTemplateFile(self: OslRenderer, arg0: FilePath) None
setOslTestShadeExecutable(self: OslRenderer, arg0: FilePath) None
setOslUtilityOSOPath(self: OslRenderer, arg0: FilePath) None
setShaderParameterOverrides(self: OslRenderer, arg0: list[str]) None
useTestRender(self: OslRenderer, arg0: bool) None
validateInputs(self: OslRenderer) None