Class ShaderParameter

Contains information about a single shader parameter.

Index

Constructors

Properties

_customAttributes _flags _identifier _name _type

Accessors

customAttributes flags identifier name type

Methods

assign clone isEqual isEqual

Constructors

constructor

new ShaderParameter(
    name?: string,
    identifier?: string,
    type?: EnumValue<ShaderParameterType>,
    flags?: EnumValue<ShaderParameterFlag>,
    customAttributes?: Iterable<ShaderParameterCustomAttribute>,
): ShaderParameter
Parameters
- Optionalname: string
- Optionalidentifier: string
- Optionaltype: EnumValue<ShaderParameterType>
- Optionalflags: EnumValue<ShaderParameterFlag>
- OptionalcustomAttributes: Iterable<ShaderParameterCustomAttribute>
Returns ShaderParameter

Properties

`Protected`_customAttributes

_customAttributes: ShaderParameterCustomAttribute[]

`Protected`_flags

_flags: EnumValue<ShaderParameterFlag>

`Protected`_identifier

_identifier: string

`Protected`_name

_name: string

`Protected`_type

_type: EnumValue<ShaderParameterType>

Accessors

customAttributes

get customAttributes(): Iterable<ShaderParameterCustomAttribute>

All custom attributes on the shader parameter.

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

flags

get flags(): EnumValue<ShaderParameterFlag>

Flags used to further describe the parameter.

Returns EnumValue<ShaderParameterFlag>
set flags(value: EnumValue<ShaderParameterFlag>): void
Parameters
- value: EnumValue<ShaderParameterFlag>
Returns void

identifier

get identifier(): string

Variable identifier of the parameter.

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

name

get name(): string

Name of the parameter variable.

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

type

get type(): EnumValue<ShaderParameterType>

Data Type of the parameter.

Returns EnumValue<ShaderParameterType>
set type(value: EnumValue<ShaderParameterType>): void
Parameters
- value: EnumValue<ShaderParameterType>
Returns void

Methods

assign

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

clone

clone(): ShaderParameter

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

Returns ShaderParameter

isEqual

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

`Static`isEqual

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