|On this page|
Samples data from a single image, or from a layer within a multi-layer image. When used in the context of rendering a geometry, the image is mapped onto the geometry based on geometry UV coordinates, with the lower-left corner of an image mapping to the (0,0) UV coordinate (or to the fractional (0,0) UV coordinate for tiled images).
When reading normal maps, set the type to “vector3”, to ensure colorspace is not applied to the incoming data.
MaterialX nodes don’t currently support string inputs. If rendering with Karma, can use a USD UV Texture to replace this node, and drive the image path with a primvar.
Color space parameters are not yet supported by UsdMaterialX.
If the file has multiple layers, then the 'default' layer will be used, or 'rgba' if there is no 'default' layer. If no value for layer is provided and the input file has multiple layers, then the 'default' layer will be used, or 'rgba' if there is no 'default' layer.
The number of channels defined by the type of the image must match the number of channels in the named layer.
The URI or path of an image file.
UsdMaterialX does not currently support the filename substitution tokens that MaterialX provides.
A default value to use if the given file can not be resolved, or if the specified layer does not exist in the file.The default value must be the same type as the image element itself.
If default is not defined, the default color value will be 0.0 in all channels.
The name of a vector2-type node specifying the 2D texture coordinate at which the image data is read. Default is to use the current u,v coordinate.
UV Address Mode
Determines how UV coordinates outside the 0-1 range are processed before sampling the image. Each UV component can be set independently to one of these modes:
Texture coordinates outside the 0-1 range return the value of the node’s default color or float parameter.
Texture coordinates are clamped to the 0-1 range before sampling the image.
Texture coordinates outside the 0-1 range “wrap around”, effectively being processed by a modulo 1 operation before sampling the image.
Texture coordinates outside the 0-1 range will be mirrored back into the 0-1 range, e.g. u=-0.01 will return the u=0.01 texture coordinate value, and u=1.01 will return the u=0.99 texture coordinate value.
U Address Mode
Determines how U coordinates outside the 0-1 range are processed before sampling the image. Default is periodic.
V Address Mode
Determines how V coordinates outside the 0-1 range are processed before sampling the image. Default is periodic.
The type of texture filtering to use; standard values include 'closest' (nearest-neighbor single-sample), 'linear', and 'cubic'. If not specified, an application may use its own default texture filtering method.
A string 'minframe-maxframe', e.g. '10-99', to specify the range of frames that the image file is allowed to have, usually the range of image files on disk. Default is unbounded
A number that is added to the current frame number to get the image file frame number. E.g. if frameoffset is 25, then processing frame 100 will result in reading frame 125 from the imagefile sequence. Default is no frame offset.
Frame End Action
What to do when the resolved image frame number is outside the framerange range.
Output from the texture image.