PlanarResource

lumin. PlanarResource

Extends

Methods

getBasePath() → {string}

Inherited From:

Gets the base path of the resource.

Returns:

Base path

Type
string

getEGLContext() → {unknown}

Returns the EGL Context associated with this resource.

NOTE: This is only available after initPlanarGLContext has been called
(this note applies only to internal applications since that method will be
called automatically when a planar resource is created by 3rd party apps
using the createPlanarEGLResource function)

Returns:
Type
unknown

getEGLSurface() → {unknown}

Returns the EGL Surface associated with this resource.

NOTE: This is only available after initPlanarGLContext has been called
(this note applies only to internal applications since that method will be
called automatically when a planar resource is created by 3rd party apps
using the createPlanarEGLResource function)

Returns:
Type
unknown

getFileName() → {string}

Inherited From:

Gets the FileName Associated with this resource.

Returns:

Filename

Type
string

getHeight() → {number}

Get the height of the resource

Returns:

height.

Type
number

getLoadStatus() → {lumin.resources.LoadStatus}

Inherited From:

Return a int that contains the result of loading this resource.

Returns:

int with the result value.

Type
lumin.resources.LoadStatus

getResourceId() → {BigInt}

Inherited From:

Returns the Unique ID of this resource

Returns:

Resource ID

Type
BigInt

getWidth() → {number}

Get the width of the resource

Returns:

the width

Type
number

isResourceValid() → {boolean}

Inherited From:

Returns True if the Resource was successfully loaded

Loading only happens on the server-side so this call is
only useful to the server

Returns:

TRUE = Successfully loaded

Type
boolean

refresh()

Refresh the resource