image

Output

RGBA

Synopsis
The 'Image' node is a color shader which performs texture mapping using a specified image file. You can control the position, size, and rotation of this frame on the surface. You can control how the texture is tiled within the frame using the Scale UV, Flip, Wrap and Swap attributes.

 


 

filename
The image filename. UDIM token functionality is supported. For efficiency reasons, UDIM substitution is not supported if image.filename is linked.
color_space
The colorspace to use for linearization when automatically generating .tx textures. You can specify which color space the texture is assumed to be in. Built-in values are linearsRGB and Rec709. The default value 'auto' will use sRGB for integer (8 or 16 bit) formats and linear otherwise.
filter
Texel interpolation method used to filter the rendered image file. Cubic is slower but smoother, closest is faster but looks blocky when magnified.
swrap
Controls how a texture repeats in the U direction on a large surface. Choose between periodic, black, clamp, mirror and file. The default wrap mode is 'periodic'. The default wrap mode for tiles (UDIM, etc) is 'mirror'. See below.
twrap

Controls how a texture repeats in the V direction on a large surface. Choose between periodic, black, clamp, mirror and file. The default wrap mode is 'periodic'. The default wrap mode for tiles (UDIM, etc) is 'mirror'.

'File' wrap mode uses the wrap setting encoded in the file itself (only applies to OpenEXR files). This is useful to preserve information about how a texture should wrap without manual correction afterward. In certain cases, 'file' mode can prevent edges. For that, to work you will need to make the correct choice when you generate mipmaps with 'maketx'. 


The example below shows an OpenEXR file used as a lat-long skydome that has the file wrap modes set to 'periodic, clamp'. Generating mip maps with this mode prevents artifacts at the sphere poles. When you leave wrap modes with their default values (periodic, periodic), you can see a dot at the top of the sphere. However, if you set wrap modes to 'file' (and use a file that has the correct wrap modes in the metadata), the dot will no longer be visible.

 

sscale
Scales the image.
tscale

Scales the image.

sflip

Flip (mirror) the image in the horizontal direction.

tflip

Flip (mirror) the image in the vertical direction.

swap_st

Swaps the axes.

single_channel

Read and outputs only the first channel of the image (which is usually R). You can force other channels by defining Start Channel.

start_channel

Allows you to offset the lookup channel.

mipmap_bias

Mip-Mapping Bias offsets the computed Mip-Map level from which the image is sampled. A negative value will force a larger Mip-Map level (clearer image); a positive value will force a smaller Mip-Map level (blurrier image).

An example of mipmap image storage. The first image on the left is shown with filtered copies reduced in size.

multiply

Multiplies the image by a constant.

offset

Uniformly darkens or lightens the texture.

uvset
A string with the name of the UV set to use to sample the image. By default, when the uvset parameter is empty, the primary UV set in the polymesh will be used. Example: If you have created a UV set in a polymesh node called "UVset2", then you can use it by setting the uvset parameter to "UVset2".
uvcoords
If uv coords are linked to a shader, the evaluation of the parameter will be used as the UV coordinates to sample the image, instead of the polymesh ones. Texture derivatives are not computed in this scenario, destroying texture mapping performance, especially in scenes with many, high-resolution textures.
soffset

Offsets the image in the U direction. This offset takes place before scaling, flipping, or swapping of the S and T coordinates. 

toffset  

Offsets the image in the V direction. This offset takes place before scaling, flipping, or swapping of the S and T coordinates. 


ignore_missing_textures

If the file corresponding to a UDIM tile is not found then by default, the render will give an error and not progress. If this option is checked, then it will not give an error and display the 'missing texture color' instead.

missing_texture_color

If the file corresponding to a UDIM tile is not found and 'ignore missing textures' is checked, then this color is displayed.
  • No labels