ImageMap

Overview

The ImageMap allows for the mapping of an image texture onto geometry. Single texture files and UDIM tiles are both supported. If <UDIM> appears in the texture filename then it will be replaced with the appropriate UDIM tile based on the st coordinates. Both exr and tx files are supported but tx files are preferred for performance reasons.


Attribute Reference

Blur attributes

mip_bias

Float bindable
default: 0.0

Amount to offset derivatives which controls mipmap selection. This can be used to provide a cheap, albiet low quality, blur. Note: Setting this value to -1.0 effectively disables mip mapping and the highest resolution will be used.

Color Correction attributes

TMI

Vec3f
default: [ 0, 0, 0 ]

T = Temperature where positive values push towards blue and negative towards red. M = Magenta where positive values push towards magenta and negative towards green. I = Intensity where negative values remove and positive values add energy

TMI_control_enabled

Bool
default: False

Enables 'TMI' (Temperature Magenta Intensity) parameter

contrast

Rgb
default: [ 1, 1, 1 ]

Applies contrast per channel in the style of Nuke where the pivot is at 0.18

contrast_enabled

Bool
default: False

Enables 'contrast' parameter

gain

Rgb
default: [ 1, 1, 1 ]

Applies multiplier per channel.

gain_offset_enabled

Bool
default: False

Enables 'gain' and 'offset_adjust' parameters

gamma_adjust

Rgb
default: [ 1, 1, 1 ]

Applies gamma(power fuction) per channel.

gamma_enabled

Bool
default: False

Enables 'gamma_adjust' parameter

offset_adjust

Rgb
default: [ 0, 0, 0 ]

Applies offset per channel.

saturation

Rgb
default: [ 1, 1, 1 ]

Applies saturation per channel with 0.0 being grayscale and 1.0 being full saturation

saturation_enabled

Bool
default: False

Enables 'saturation' parameter

General attributes

alpha_only

Bool
default: False

If true, the alpha channel of the texture will be placed in the rgb channels. If the texture has no alpha channel, 1.0 is used, and the resulting texture lookup is then always white.

default_color

Rgb
default: [ 0, 1, 0 ]

Default color to be used for missing udims when 'use default color when missing' is enabled

gamma

Int enum
  0 = “off”
  1 = “on”
  2 = “auto” (default)

If this is set to 'on' or 'auto' and the 'texture' file is 8-bit, then a power of 2.2 will be applied to the RGB channels of the image.

input_texture_coordinates

Vec3f bindable
default: [ 0, 0, 0 ]

If the 'texture_coordinates' parameter is set to 'input texture coordinates' then this parameter is evaluated and the resulting red and green channels are used for the u and v coordinates respectively.

offset

Vec2f
default: [ 0, 0 ]

A constant offset applied to the texture coordinates.

rotation_angle

Float
default: 0.0

A constant rotation in degrees applied to the texture coordinates.

rotation_center

Vec2f
default: [ 0.5, 0.5 ]

UV coordinate around which to rotate

scale

Vec2f
default: [ 1, 1 ]

A constant scale applied to the texture coordinates.

texture

String filename
default:

Filename that points to a texture .exr or .tx file (must be mip-mapped and tiled with maketx). If filename contains '<UDIM>', udim index substitution is performed on filename. In the UDIM case, 'scale', 'offset', and 'wrap around' are ignored.

texture_coordinates

Int enum
  0 = “texture” (default)
  1 = “hair surface”
  2 = “input texture coordinates”
  3 = “hair closest surface”

Selects the source of the coordinates used to map the texture. For meshes, the 'texture' setting will read a Vec2f attribute named 'surface_st' if it exists, otherwise it will use barycentric coordinates. For points and curves, the 'texture' setting will read a Vec2f attribute named 'uv' if it exists. If the attribute doesn't exist, parametric st coordinates are used for curves and a constant value of (1.0, 1.0) is used for points. The 'input texture coordinates' setting will evaluate a binding on the 'input_texture_coordinates' parameter and use the resulting red and green channels as the texture coordinates. The 'hair surface' setting will try to read an explicit attribute named 'surface_st'. The 'hair closest surface' setting will try to read an explicit attribute named 'closest_surface_uv'.

udim_files

StringVector
default: {}

Explicit list of UDIM filenames corresponding to values in the 'udim_values' list. If this is set, the 'texture' parameter is ignored.

udim_max_v

Int
default: 10

Maximum UDIM v value used (maximum UDIM row). Needed to for texture allocation.

udim_values

IntVector
default: {}

Explicit list of UDIM values corresponding to filename in the 'udim_files' list.

use_default_color_when_missing

Bool
default: False

Uses the 'default color' for missing udims and does not report error

wrap_around

Bool
default: True

If true, the image will repeat itself at it's boundries. If false, the image will be clamped at it's boundries.