Skip to main content

Interface: CreateImageSpriteOptions

Defined in: rendering/utilities/create-image-sprite.ts:48

Properties​

emissiveMap?​

optional emissiveMap?: EmissiveMapOptions

Defined in: rendering/utilities/create-image-sprite.ts:58

The emissive map to add on top of the sprite's tinted albedo, unaffected by lighting. Omit for a sprite with no emissive contribution.

frameDimensions?​

optional frameDimensions?: Vector2

Defined in: rendering/utilities/create-image-sprite.ts:52

The dimensions of a single frame in the image, for sprite sheets. Defaults to the full image size (i.e. a single-frame sprite).

layer?​

optional layer?: number

Defined in: rendering/utilities/create-image-sprite.ts:79

The render layer for the sprite. Defaults to 1.

pixelated?​

optional pixelated?: boolean

Defined in: rendering/utilities/create-image-sprite.ts:67

Samples the sprite's texture (and its emissive map, if any) with nearest- neighbor filtering for crisp, blocky scaling, appropriate for pixel-art assets. Defaults to false, which uses linear filtering so the sprite's own anti-aliased edges (for example a soft-edged circle) are preserved instead of being sampled into a hard, staggered stair-step.

pixelsPerUnit?​

optional pixelsPerUnit?: number

Defined in: rendering/utilities/create-image-sprite.ts:85

How many pixels of the sprite's texture span one world unit. Defaults to 100.

slices?​

optional slices?: NineSliceOptions

Defined in: rendering/utilities/create-image-sprite.ts:74

Nine-slice configuration, for a sprite whose corners should stay a fixed size while its edges/center stretch or tile. Omit for a normal, single-quad sprite.