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

__init__(*args, **kwargs)
acquireImage(self, filePath, defaultColor)
addLoader(self, arg0)
bindImage(self, arg0, arg1)
clearImageCache(self)
create(arg0)
createRenderResources(self, arg0, arg1, arg2)
getFilenameResolver(self)
getReferencedImages(self, arg0)
getSearchPath(self)
getZeroImage(self)
releaseRenderResources(self[, image])
saveImage(self, filePath, image[, verticalFlip])
setFilenameResolver(self, arg0)
setSearchPath(self, arg0)
unbindImage(self, arg0)
unbindImages(self)

Methods

__init__(*args, **kwargs)

acquireImage(self: ImageHandler, filePath: FilePath, defaultColor: Color4 = <Color4 object at 0x107d90d30>) → Image

addLoader(self: ImageHandler, arg0: ImageLoader) → None

bindImage(self: ImageHandler, arg0: Image, arg1: ImageSamplingProperties) → bool

clearImageCache(self: ImageHandler) → None

static create(arg0: ImageLoader) → ImageHandler

createRenderResources(self: ImageHandler, arg0: Image, arg1: bool, arg2: bool) → bool

getFilenameResolver(self: ImageHandler) → StringResolver

getReferencedImages(self: ImageHandler, arg0: Document) → list[Image]

getSearchPath(self: ImageHandler) → FileSearchPath

getZeroImage(self: ImageHandler) → Image

releaseRenderResources(self: ImageHandler, image: Image = None) → None

saveImage(self: ImageHandler, filePath: FilePath, image: Image, verticalFlip: bool = False) → bool

setFilenameResolver(self: ImageHandler, arg0: StringResolver) → None

setSearchPath(self: ImageHandler, arg0: FileSearchPath) → None

unbindImage(self: ImageHandler, arg0: Image) → bool

unbindImages(self: ImageHandler) → None