Class FilterData

Library description of a LUT filter asset that can later be instantiated as a Pixi texture/filter pair.

Index

Constructors

Methods

createPixiTexture getId getIsSerializable getLutUrl getName getProvider init serialize deserialize

Constructors

constructor

new FilterData(options: FilterDataOptions): FilterData
Parameters
- options: FilterDataOptions
Returns FilterData

Methods

createPixiTexture

createPixiTexture(): null | Texture<Resource>
Creates a Pixi texture from the loaded LUT bitmap using nearest sampling.

Nearest filtering is intentional here to avoid introducing interpolation artifacts when sampling LUT cells.

Returns null | Texture<Resource>
Pixi texture for the LUT image, or null if the LUT is not loaded.

getId

getId(): string
Returns string

getIsSerializable

getIsSerializable(): boolean
Returns boolean

getLutUrl

getLutUrl(): string
Returns string

getName

getName(): string
Returns string

getProvider

getProvider(): string
Returns string

init

init(): Promise<void>
Loads the LUT image referenced by the filter definition.

Returns Promise<void>
A promise that resolves after the LUT bitmap has been fetched or the load attempt has failed.

serialize

serialize(): { id: string; lutUrl: string; name: string; provider: string }
Serializes the filter definition into project-safe data.

Returns { id: string; lutUrl: string; name: string; provider: string }
Serialized filter definition payload.

`Static`deserialize

deserialize(data: object): FilterData
Reconstructs a filter definition from serialized data.
Parameters
- data: object
  Serialized filter definition payload.
Returns FilterData
Deserialized filter definition.