Class Shader

Hierarchy

Shader

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new Shader(options?: IShaderOptions): Shader

- Defined in src/Shader/index.ts:39
Parameters
- Optional options: IShaderOptions
  
  Create options
Returns Shader

Properties

Private _code

_code: ShaderCodeType = null

Private _name

_name: string = null

Private _resource

_resource: GPUShaderModule = null

Private _stage

_stage: SHADER_STAGE = SHADER_STAGE.NONE

Methods

create

create(renderer: Renderer, descriptor: GPUShaderModuleDescriptor): void

- Defined in src/Shader/index.ts:89
Create the GPU resource of the shader

Parameters
- renderer: Renderer
  
  Renderer instance
- descriptor: GPUShaderModuleDescriptor
  
  The descriptor used to create the shader
Returns void

destroy

destroy(): void

- Defined in src/Shader/index.ts:100
Destroy this Object

Returns void

getCode

getCode(): ShaderCodeType

- Defined in src/Shader/index.ts:72
Returns the shader's GLSL or SPIRV code

Returns ShaderCodeType

getName

getName(): string

- Defined in src/Shader/index.ts:61
The shader name

Returns string

getResource

getResource(): GPUShaderModule

- Defined in src/Shader/index.ts:82
The GPU shader resource

Returns GPUShaderModule

getStage

getStage(): SHADER_STAGE

- Defined in src/Shader/index.ts:77
Returns the shader's stage

Returns SHADER_STAGE

setName

setName(value: string): void

- Defined in src/Shader/index.ts:67
Update the shader name

Parameters
- value: string
  
  The new shader name
Returns void

Generated using TypeDoc