Documentation / Node reference / tex nodes

tex/CustomImage

A texture whose image is given by the app's code.

Files

Use it to ship an image inside the app itself rather than as a file next to it. The app's code hands the image over, usually in afterInit, with setCustomImageEncoded (the content of a PNG or JPEG file) or setCustomImageRGBA8 (decoded pixels, 4 bytes per texel). The image is copied into the node.

The image is not saved with the scene. Until the app sets one, the node shows a single grey texel and a warning, so the materials it feeds still have a texture.

Parameters

Name Type What it does
colorSpace UInt8 sRGB · Linear sRGB for color images such as photos. Linear for data such as normal maps or masks.
generateMipmaps Bool Builds smaller copies of the image, so it stays smooth when seen from far away.
mipmapsFilter UInt8 Box · EnvironmentGGX Box for surface textures. EnvironmentGGX for an equirectangular map used as environment lighting.

See also

This page is generated from the engine, so it describes the release you can download. The same text is in the editor's Help panel next to the node itself.