Nodes > Functions > Sample > Flipbook Sample

Samples colors from frames on an animated flipbook sheet. Useful for animating textures.

Inputs

Name	Type	Description
Texture	tex2D	Flipbook texture to sample
Frame Count	float	Horizontal and vertical number of frames appearing on the flipbook sheet
Max Frames	float	Number of valid animation frames. Frame numbers higher than this are ignored, useful when working with a flipbook texture having empty frames at the end.
UV Coords	float	Coordinates relative to the drawing area. Should be range 0-1
Offset (frames)	float	Frame offset to apply
Speed (fps)	float	When animation is enabled, controls animation speed in frames per second
Offset (seconds)	float	When animation is enabled, applies a time offset in seconds

Outputs

Name	Type	Description
Color	color	Sampled color of the current frame to draw on the flipbook sheet

Properties

Name	Type	Description
Coords	dropdown	Choose what source to use for the UV Coordinates. If "UV Coord 0" or "UV1 Coord 1" are selected, the respective surface UV set will be used. If "Custom" is selected, the UV Coords input will be exposed and used instead
Animate	bool	If enabled, the current frame will animate over time, cycling horizontally then vertically through the flipbook sheet