Class SpriteSheet (1.5.2)

SpriteSheet(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Sprite sheet configuration.

Attributes

NameDescription
format_ str
Format type. The default is jpeg. Supported formats: - jpeg
file_prefix str
Required. File name prefix for the generated sprite sheets. If multiple sprite sheets are added to the channel, each must have a unique file prefix. Each sprite sheet has an incremental 10-digit zero-padded suffix starting from 0 before the extension, such as sprite_sheet0000000123.jpeg.
sprite_width_pixels int
Required. The width of the sprite in pixels. Must be an even integer.
sprite_height_pixels int
Required. The height of the sprite in pixels. Must be an even integer.
column_count int
The maximum number of sprites per row in a sprite sheet. Valid range is [1, 10] and the default value is 1.
row_count int
The maximum number of rows per sprite sheet. When the sprite sheet is full, a new sprite sheet is created. Valid range is [1, 10] and the default value is 1.
interval google.protobuf.duration_pb2.Duration
Create sprites at regular intervals. Valid range is [1 second, 1 hour] and the default value is 10s.
quality int
The quality of the generated sprite sheet. Enter a value between 1 and 100, where 1 is the lowest quality and 100 is the highest quality. The default is 100. A high quality value corresponds to a low image data compression ratio.