Header menu logo Mibo

SpriteState Module

Convenience builders for SpriteState.

Functions and values

Function or value Description

create (texture, dest, source)

Full Usage: create (texture, dest, source)

Parameters:
Returns: SpriteState

Creates a sprite state with required fields. Defaults: Origin=Zero, Rotation=0, Color=White, Layer=0.

texture : Texture2D
dest : Rectangle
source : Rectangle
Returns: SpriteState

withColor v s

Full Usage: withColor v s

Parameters:
Returns: SpriteState
Modifiers: inline

Sets the tint color.

v : Color
s : SpriteState
Returns: SpriteState

withLayer v s

Full Usage: withLayer v s

Parameters:
Returns: SpriteState
Modifiers: inline

Sets the render layer.

v : int<MeasureProduct<RenderLayer, MeasureOne>>
s : SpriteState
Returns: SpriteState

withNormalMap v s

Full Usage: withNormalMap v s

Parameters:
Returns: SpriteState
Modifiers: inline

Sets the normal map texture for per-pixel lighting.

v : Texture2D
s : SpriteState
Returns: SpriteState

withOrigin v s

Full Usage: withOrigin v s

Parameters:
Returns: SpriteState
Modifiers: inline

Sets the origin point for rotation/positioning.

v : Vector2
s : SpriteState
Returns: SpriteState

withRotation v s

Full Usage: withRotation v s

Parameters:
Returns: SpriteState
Modifiers: inline

Sets the rotation in radians.

v : float32
s : SpriteState
Returns: SpriteState

Type something to start searching.