Image Atlas

Overview

image
The image atlas sampler allows you to sample a 2D texture atlas, and get the number of sub-UV rects, as well as their coordinates.
It can be used either through the atlas sampler script functions, or using the template core-library nodes, such as atlas.sample.

Property

Type

Description

AtlasSource

enum

Specifies where the sampler fetches the atlas/sub-UV data

  • Procedural: atlas is defined by an u*v tile count

  • External: sampler will load an external atlas definition file (.pkat)

AtlasSubdiv

uint2

Number of sub-rectangles in the atlas, along each UV dimension.

AtlasDefinition

String

Optional path to a texture atlas file (see how to create atlas files), relative to the root of the project.
If a path is specified, will allow to sample sub-frames of the image independently, like in billboard renderers.

Output pins

Data

dataImage

Image resource

+ all sampler properties