Class ShaderVariationParamInfo

Represents a single shader variation parameter and a set of all possible values.

Index

Constructors

Properties

_identifier _isInternal _name _values

Accessors

identifier isInternal name values

Methods

assign clone isEqual isEqual

Constructors

constructor

new ShaderVariationParamInfo(
    name?: string,
    identifier?: string,
    isInternal?: boolean,
    values?: Iterable<ShaderVariationParamValue>,
): ShaderVariationParamInfo
Parameters
- Optionalname: string
- Optionalidentifier: string
- OptionalisInternal: boolean
- Optionalvalues: Iterable<ShaderVariationParamValue>
Returns ShaderVariationParamInfo

Properties

`Protected`_identifier

_identifier: string

`Protected`_isInternal

_isInternal: boolean

`Protected`_name

_name: string

`Protected`_values

_values: ShaderVariationParamValue[]

Accessors

identifier

get identifier(): string

RSL identifier for the parameter.

Returns string
set identifier(value: string): void
Parameters
- value: string
Returns void

isInternal

get isInternal(): boolean

True if the parameter is for internal use by the renderer, and false if its intended to be set by the user.

Returns boolean
set isInternal(value: boolean): void
Parameters
- value: boolean
Returns void

name

get name(): string

Optional human-readable name describing the variation parameter.

Returns string
set name(value: string): void
Parameters
- value: string
Returns void

values

get values(): Iterable<ShaderVariationParamValue>

A list of potential values this parameter can take on.

Returns Iterable<ShaderVariationParamValue>
set values(
value: Iterable<ShaderVariationParamValue> | ShaderVariationParamValue[],
): void
Parameters
- value: Iterable<ShaderVariationParamValue> | ShaderVariationParamValue[]
Returns void

Methods

assign

assign(other: Immutable<ShaderVariationParamInfo>): ShaderVariationParamInfo
Copies all properties defined by the prototype of ShaderVariationParamInfo from other to this instance.
Parameters
- other: Immutable<ShaderVariationParamInfo>
Returns ShaderVariationParamInfo

clone

clone(): ShaderVariationParamInfo

Clones this instance and returns a new ShaderVariationParamInfo with identical values.

Returns ShaderVariationParamInfo

isEqual

isEqual(
this: Immutable<ShaderVariationParamInfo>,
other: Immutable<ShaderVariationParamInfo>,
): boolean
Determines if this ShaderVariationParamInfo instance is equal to the other instance.
Parameters
- this: Immutable<ShaderVariationParamInfo>
- other: Immutable<ShaderVariationParamInfo>
Returns boolean

`Static`isEqual

isEqual(
lhs: Immutable<ShaderVariationParamInfo>,
rhs: Immutable<ShaderVariationParamInfo>,
): boolean
Determines if both ShaderVariationParamInfo instances are equal.
Parameters
- lhs: Immutable<ShaderVariationParamInfo>
- rhs: Immutable<ShaderVariationParamInfo>
Returns boolean