Interface UiBackgroundProps

Background Component props .i.e to define a background color or image

Hierarchy

  • UiBackgroundProps

Properties

avatarTexture? color? texture? textureMode? textureSlices? uvs? videoTexture?

Properties

Optional avatarTexture

avatarTexture?: UiAvatarTexture

AvatarTexture for the background

Optional color

color?: PBColor4

Background color.

Default Value

{ r: 1, g: 1, b: 1, a: 1 }

Optional texture

texture?: UiTexture

Texture for the background

Optional textureMode

textureMode?: TextureMode

Optional textureSlices

textureSlices?: BorderRect

Texture slices represents the top | right | bottom | left sizes of the slices for the borders. Values are percentages of the texture.

Optional uvs

uvs?: number[]

when STRETCH is selected, the uvs are configurable

Optional videoTexture

videoTexture?: UiVideoTexture

VideoTexture for the background

Settings

Member Visibility

Theme