Class ShaderVariation

Contains information about a single variation of a Shader. Each variation can have a separate set of #defines that control shader compilation.

Index

Constructors

Accessors

Methods

clearParameters getBool getFloat getInteger getUnsignedInteger hasParameter removeParameter setBool setFloat setInteger setUnsignedInteger

Constructors

constructor

new ShaderVariation(isInternalConstructor?: boolean): ShaderVariation
Parameters
- OptionalisInternalConstructor: boolean
Returns ShaderVariation

Overrides FrameworkObject.constructor

Accessors

paramNames

get paramNames(): Iterable<string>

Returns a list of names of all registered parameters.

Returns Iterable<string>

Methods

clearParameters

clearParameters(): void

Removes all parameters.

Returns void

getBool

getBool(name: string): boolean
Returns the value of a boolean parameter with the specified name. Returns false if the parameter cannot be found.
Parameters
- name: string
Returns boolean

getFloat

getFloat(name: string): number
Returns the value of a float parameter with the specified name. Returns 0 if the parameter cannot be found.
Parameters
- name: string
Returns number

getInteger

getInteger(name: string): number
Returns the value of a signed integer parameter with the specified name. Returns 0 if the parameter cannot be found.
Parameters
- name: string
Returns number

getUnsignedInteger

getUnsignedInteger(name: string): number
Returns the value of a unsigned integer parameter with the specified name. Returns 0 if the parameter cannot be found.
Parameters
- name: string
Returns number

hasParameter

hasParameter(paramName: string): boolean
Checks if the variation has a parameter with the specified name.
Parameters
- paramName: string
Returns boolean

removeParameter

removeParameter(paramName: string): void
Removes a parameter with the specified name.
Parameters
- paramName: string
Returns void

setBool

setBool(name: string, value: boolean): void
Sets the value of the parameter for the provided name. Any previous value for a parameter with the same name will be overwritten.
Parameters
- name: string
- value: boolean
Returns void

setFloat

setFloat(name: string, value: number): void
Sets the value of the parameter for the provided name. Any previous value for a parameter with the same name will be overwritten.
Parameters
- name: string
- value: number
Returns void

setInteger

setInteger(name: string, value: number): void
Sets the value of the parameter for the provided name. Any previous value for a parameter with the same name will be overwritten.
Parameters
- name: string
- value: number
Returns void

setUnsignedInteger

setUnsignedInteger(name: string, value: number): void
Sets the value of the parameter for the provided name. Any previous value for a parameter with the same name will be overwritten.
Parameters
- name: string
- value: number
Returns void