Interface SpriteSheetOrBuilder (0.26.0)

public interface SpriteSheetOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getColumnCount()

public abstract int getColumnCount()

The maximum number of sprites per row in a sprite sheet. Valid range is [1, 10] and the default value is 1.

int32 column_count = 5;

Returns
TypeDescription
int

The columnCount.

getFilePrefix()

public abstract String getFilePrefix()

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.

string file_prefix = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
String

The filePrefix.

getFilePrefixBytes()

public abstract ByteString getFilePrefixBytes()

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.

string file_prefix = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
ByteString

The bytes for filePrefix.

getFormat()

public abstract String getFormat()

Format type. The default is jpeg.

Supported formats:

  • jpeg

string format = 1;

Returns
TypeDescription
String

The format.

getFormatBytes()

public abstract ByteString getFormatBytes()

Format type. The default is jpeg.

Supported formats:

  • jpeg

string format = 1;

Returns
TypeDescription
ByteString

The bytes for format.

getInterval()

public abstract Duration getInterval()

Create sprites at regular intervals. Valid range is [1 second, 1 hour] and the default value is 10s.

.google.protobuf.Duration interval = 7;

Returns
TypeDescription
Duration

The interval.

getIntervalOrBuilder()

public abstract DurationOrBuilder getIntervalOrBuilder()

Create sprites at regular intervals. Valid range is [1 second, 1 hour] and the default value is 10s.

.google.protobuf.Duration interval = 7;

Returns
TypeDescription
DurationOrBuilder

getQuality()

public abstract int getQuality()

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.

int32 quality = 8;

Returns
TypeDescription
int

The quality.

getRowCount()

public abstract int getRowCount()

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.

int32 row_count = 6;

Returns
TypeDescription
int

The rowCount.

getSpriteHeightPixels()

public abstract int getSpriteHeightPixels()

Required. The height of the sprite in pixels. Must be an even integer.

int32 sprite_height_pixels = 4 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
int

The spriteHeightPixels.

getSpriteWidthPixels()

public abstract int getSpriteWidthPixels()

Required. The width of the sprite in pixels. Must be an even integer.

int32 sprite_width_pixels = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
int

The spriteWidthPixels.

hasInterval()

public abstract boolean hasInterval()

Create sprites at regular intervals. Valid range is [1 second, 1 hour] and the default value is 10s.

.google.protobuf.Duration interval = 7;

Returns
TypeDescription
boolean

Whether the interval field is set.