import UiSprite from 'oxygen-core/components/UiSprite.js'

public class | source

UiSprite

Extends:

Component → VerticesRenderer → UiSprite

Static Member Summary

Static Public Members
public static get	propsTypes: {"visible": , "shader": , "overrideUniforms": , "overrideSamplers": , "layers": *, "overrideBaseTexture": string, "overrideBaseFiltering": string, "camera": string, "width": string, "height": string, "widthAnchor": string, "heightAnchor": string, "xOrigin": string, "yOrigin": string, "topOffset": string, "bottomOffset": string, "leftOffset": string, "rightOffset": string, "topBorder": string, "bottomBorder": string, "leftBorder": string, "rightBorder": string, "atlas": string, "color": string}

Static Method Summary

Static Public Methods
public static	factory(): *

Constructor Summary

Public Constructor
public	constructor()

Member Summary

Public Members
public get	atlas: *
public set	atlas
public get	bottomBorder: *
public set	bottomBorder
public get	bottomOffset: *
public set	bottomOffset
public get	cachedHeight: *
public get	cachedWidth: *
public get	camera: *
public set	camera
public get	color: *
public set	color
public get	height: *
public set	height
public get	heightAnchor: *
public set	heightAnchor
public	indices: number[]
public get	leftBorder: *
public set	leftBorder
public get	leftOffset: *
public set	leftOffset
public get	overrideBaseFiltering: *
public set	overrideBaseFiltering
public get	overrideBaseTexture: *
public set	overrideBaseTexture
public	overrideSamplers: *
public	overrideUniforms: *
public get	rightBorder: *
public set	rightBorder
public get	rightOffset: *
public set	rightOffset
public get	topBorder: *
public set	topBorder
public get	topOffset: *
public set	topOffset
public	vertices: undefined[]
public get	width: *
public set	width
public get	widthAnchor: *
public set	widthAnchor
public get	xOrigin: *
public set	xOrigin
public get	yOrigin: *
public set	yOrigin

Method Summary

Public Methods
public	dispose()
public	ensureVertices(renderer: *)
public	onAction(name: , args: ...): *
public	onAttach()
public	onCameraChanged(camera: *)
public	onPropertySerialize(name: , value: ): *
public	onRender(gl: , renderer: , deltaTime: , layer: )
public	recalculateSize()

Inherited Summary

From class Component
public static get	propsTypes: *
public static	factory(): Component Component factory.
public get	entity: Entity \| null
public	[name]: *
public	deserialize(json: *) Deserialize JSON properties into this component.
public	dispose() Destructor (dispose internal resources and detach from entity).
public	onAction(name: string, args: *) Called when action arrived.
public	onAlterActionArguments(name: string, args: *): array \| undefined Called when asked to alter arrived action parameters.
public	onAttach() Called after attached to entity.
public	onDetach() Called before detached from entity.
public	onPropertySerialize(name: string, value: ): Called when property is serialized.
public	onPropertySetup(name: string, value: *) Called when given property is deserialized.
public	serialize(): * Serialize component into JSON data.

From class VerticesRenderer
public static get	BufferUsage: *
public static get	RenderMode: *
public static get	propsTypes: {"visible": string, "shader": string, "vertices": string, "indices": string, "verticesUsage": string, "indicesUsage": string, "overrideUniforms": string, "overrideSamplers": string, "renderMode": string, "layers": string}
public static	factory(): *
public get	indices: *
public set	indices
public get	indicesUsage: *
public set	indicesUsage
public get	layers: undefined[]
public set	layers
public get	overrideSamplers: *
public set	overrideSamplers
public get	overrideUniforms: *
public set	overrideUniforms
public get	renderMode: *
public set	renderMode
public get	shader: *
public set	shader
public get	vertices: *
public set	vertices
public get	verticesUsage: *
public set	verticesUsage
public get	visible: *
public set	visible
public	dispose()
public	onAction(name: , args: ...): *
public	onPreview(gl: , renderer: , deltaTime: *)
public	onPropertySerialize(name: , value: ): *
public	onRender(gl: , renderer: , deltaTime: , layer: )
public	onRenderLayer(gl: , renderer: , deltaTime: , layer: )
public	reuploadData()
public	updateIndicesChunk(data: , offset: , size: number)
public	updateVerticesChunk(data: , offset: , size: number)

Static Public Members

public static get propsTypes: {"visible": , "shader": , "overrideUniforms": , "overrideSamplers": , "layers": *, "overrideBaseTexture": string, "overrideBaseFiltering": string, "camera": string, "width": string, "height": string, "widthAnchor": string, "heightAnchor": string, "xOrigin": string, "yOrigin": string, "topOffset": string, "bottomOffset": string, "leftOffset": string, "rightOffset": string, "topBorder": string, "bottomBorder": string, "leftBorder": string, "rightBorder": string, "atlas": string, "color": string} source

Override:

VerticesRenderer#propsTypes

Static Public Methods

public static factory(): * source

Component factory.

Override:

VerticesRenderer#factory

Return:

Public Constructors

public constructor() source

Constructor.

Override:

VerticesRenderer#constructor

Public Members

public get atlas: * source

public set atlas source

public get bottomBorder: * source

public set bottomBorder source

public get bottomOffset: * source

public set bottomOffset source

public get cachedHeight: * source

public get cachedWidth: * source

public get camera: * source

public set camera source

public get color: * source

public set color source

public get height: * source

public set height source

public get heightAnchor: * source

public set heightAnchor source

public indices: number[] source

Override:

VerticesRenderer#indices

public get leftBorder: * source

public set leftBorder source

public get leftOffset: * source

public set leftOffset source

public get overrideBaseFiltering: * source

public set overrideBaseFiltering source

public get overrideBaseTexture: * source

public set overrideBaseTexture source

public overrideSamplers: * source

Override:

VerticesRenderer#overrideSamplers

public overrideUniforms: * source

Override:

VerticesRenderer#overrideUniforms

public get rightBorder: * source

public set rightBorder source

public get rightOffset: * source

public set rightOffset source

public get topBorder: * source

public set topBorder source

public get topOffset: * source

public set topOffset source

public vertices: undefined[] source

Override:

VerticesRenderer#vertices

public get width: * source

public set width source

public get widthAnchor: * source

public set widthAnchor source

public get xOrigin: * source

public set xOrigin source

public get yOrigin: * source

public set yOrigin source

Public Methods

public dispose() source

Destructor (dispose internal resources and detach from entity).

Override:

VerticesRenderer#dispose

public ensureVertices(renderer: *) source

Params:

Name	Type	Attribute	Description
renderer	*

public onAction(name: , args: ...): * source

Called when action arrived.

Override:

VerticesRenderer#onAction

Params:

Name	Type	Attribute	Description
name	*
args	...*

Return:

public onAttach() source

Called after attached to entity.

Override:

Component#onAttach

public onCameraChanged(camera: *) source

Params:

Name	Type	Attribute	Description
camera	*

public onPropertySerialize(name: , value: ): * source

Called when property is serialized.

Override:

VerticesRenderer#onPropertySerialize

Params:

Name	Type	Attribute	Description
name	*
value	*

Return:

public onRender(gl: , renderer: , deltaTime: , layer: ) source

Override:

VerticesRenderer#onRender

Params:

Name	Type	Attribute	Description
gl	*
renderer	*
deltaTime	*
layer	*

UiSprite

Extends:

Static Member Summary

Static Method Summary

Constructor Summary

Member Summary

Method Summary

Inherited Summary

Static Public Members

Override:

Static Public Methods

public static factory(): * source

Override:

Return:

Public Constructors

public constructor() source

Override:

Public Members

public get atlas: * source

public set atlas source

public get bottomBorder: * source

public set bottomBorder source

public get bottomOffset: * source

public set bottomOffset source

public get cachedHeight: * source

public get cachedWidth: * source

public get camera: * source

public set camera source

public get color: * source

public set color source

public get height: * source

public set height source

public get heightAnchor: * source

public set heightAnchor source

public indices: number[] source

Override:

public get leftBorder: * source

public set leftBorder source

public get leftOffset: * source

public set leftOffset source

public get overrideBaseFiltering: * source

public set overrideBaseFiltering source

public get overrideBaseTexture: * source

public set overrideBaseTexture source

public overrideSamplers: * source

Override:

public overrideUniforms: * source

Override:

public get rightBorder: * source

public set rightBorder source

public get rightOffset: * source

public set rightOffset source

public get topBorder: * source

public set topBorder source

public get topOffset: * source

public set topOffset source

public vertices: undefined[] source

Override:

public get width: * source

public set width source

public get widthAnchor: * source

public set widthAnchor source

public get xOrigin: * source

public set xOrigin source

public get yOrigin: * source

public set yOrigin source

Public Methods

public dispose() source

Override:

public ensureVertices(renderer: *) source

Params:

public onAction(name: *, args: ...*): * source

Override:

Params:

Return:

public onAttach() source

Override:

public onCameraChanged(camera: *) source

Params:

public onPropertySerialize(name: *, value: *): * source

public onAction(name: , args: ...): * source

public onPropertySerialize(name: , value: ): * source

public onRender(gl: , renderer: , deltaTime: , layer: ) source