TK_Custom_Shader

class TK_Custom_Shader

Handles the TKE_Custom_Shader opcode.

TKE_Custom_Shader provides support for writing/reading the TKE_Custom_Shader opcode object to/from an HSF file.

The HOOPS/3dGS scene-graph supports custom shader.

Inherits from: BBaseOpcodeHandler

Methods

TK_Custom_Shader::TK_Custom_Shader()

constructor

TK_Custom_Shader::~TK_Custom_Shader()
TK_Status TK_Custom_Shader::Read(BStreamFileToolkit &tk)

virtual

Reads data from the toolkit buffer, decodes/decompresses it, and maps it to the opcode handlers data members. User-defined classes which need to write out custom data should utilize one of the available GetData() methods.

Parameters

tk: A reference to the BStreamFileToolkit object.

Returns

The result of the function call.
TK_Status TK_Custom_Shader::Write(BStreamFileToolkit &tk)

virtual

Encodes/compresses data and writes data to the toolkit buffer. User-defined classes which need to write out custom data should utilize one of the available PutData() methods, and first write out the opcode associated with the group of binary data followed by the data itself.

Parameters

tk: A reference to the BStreamFileToolkit object.

Returns

The result of the function call.
TK_Status TK_Custom_Shader::Clone(BStreamFileToolkit &tk, BBaseOpcodeHandler **handler) const

const virtual

Copies the opcode handler

Parameters

tk: A reference to the BStreamFileToolkit object.

handler: A pointer to the opcode handler object. Passed by reference.

Returns

The result of the function call.
TK_Status TK_Custom_Shader::ReadAscii(BStreamFileToolkit &tk)

Deprecated.

TK_Status TK_Custom_Shader::WriteAscii(BStreamFileToolkit &tk)

Deprecated.

void TK_Custom_Shader::Reset()

virtual

Resets the current opcode handler. This is called by the toolkit when it is done processing an opcode. This method reinitializes any opcode handler variables and frees up temporary data.

void TK_Custom_Shader::SetShaderTag(TKO_Custom_Shader_Def_Stage shader_stage, TKO_Custom_Shader_Primitive primitive_enum, int tag)

Sets the shader tag

bool TK_Custom_Shader::GetShaderTag(TKO_Custom_Shader_Def_Stage shader_stage, TKO_Custom_Shader_Primitive primitive_enum, int &tag)

Gets the shader tag

void TK_Custom_Shader::SetVertexShaderTag(TKO_Custom_Shader_Primitive primitive_enum, int tag)

Sets the vertex shader tag

bool TK_Custom_Shader::GetVertexShaderTag(TKO_Custom_Shader_Primitive primitive_enum, int &tag)

Gets the vertex shader tag

TK_Status TK_Custom_Shader::SetShaderTag(BStreamFileToolkit &tk, TKO_Custom_Shader_Def_Stage shader_stage, TKO_Custom_Shader_Primitive primitive_enum, long long shader_key)

Sets the shader tag

void TK_Custom_Shader::SetPixelShaderTag(TKO_Custom_Shader_Primitive primitive_enum, int tag)

Sets the pixel shader tag

bool TK_Custom_Shader::GetPixelShaderTag(TKO_Custom_Shader_Primitive primitive_enum, int &tag)

Gets the pixel shader tag

void TK_Custom_Shader::SetShaderUniformsData(TKO_Custom_Shader_Def_Stage shader_stage, TKO_Custom_Shader_Primitive primitive_enum, unsigned char const *data, int length)

Sets the shader uniforms data

TKO_Custom_Shader_Option_Bits TK_Custom_Shader::GetShaderUniformsDataFlag(TKO_Custom_Shader_Def_Stage shader_stage, TKO_Custom_Shader_Primitive primitive_enum)

Gets the shader uniforms data flag

bool TK_Custom_Shader::GetPrimitiveEnum(char const *primitive, TKO_Custom_Shader_Primitive &primitive_enum)

Gets the primitive enum

bool TK_Custom_Shader::GetPrimitiveString(TKO_Custom_Shader_Primitive primitive_enum, char *primitive)

Gets the primitive string

void TK_Custom_Shader::SetVertexShaderUniformsData(TKO_Custom_Shader_Primitive primitive_enum, unsigned char const *data, int length)

private

Sets the vertex shader uniforms data

void TK_Custom_Shader::SetVertexShaderUniformsData(TKO_Custom_Shader_Primitive primitive_enum, int length)

private

Sets the vertex shader uniforms data length

void TK_Custom_Shader::SetPixelShaderUniformsData(TKO_Custom_Shader_Primitive primitive_enum, unsigned char const *data, int length)

private

Sets the pixel shader uniforms data

void TK_Custom_Shader::SetPixelShaderUniformsData(TKO_Custom_Shader_Primitive primitive_enum, int length)

private

Sets the pixel shader uniforms data length

Variables

int TK_Custom_Shader::m_flags

protected

int

internal use; Flags indicating presence of optional values

int TK_Custom_Shader::m_vertex_shader_tag[TKO_Custom_Shader_Primitive_Count]

protected

int

internal use; Custom shader vertex shader tag

int TK_Custom_Shader::m_pixel_shader_tag[TKO_Custom_Shader_Primitive_Count]

protected

int

internal use; Custom shader pixel shader tag

unsigned char *TK_Custom_Shader::m_vertex_uniforms_data[TKO_Custom_Shader_Primitive_Count]

protected

unsigned char

internal use; Custom shader vertex shader uniforms data

unsigned char *TK_Custom_Shader::m_pixel_uniforms_data[TKO_Custom_Shader_Primitive_Count]

protected

unsigned char

internal use; Custom shader pixel shader uniforms data

int TK_Custom_Shader::m_vertex_uniforms_data_length[TKO_Custom_Shader_Primitive_Count]

protected

int

internal use; Custom shader vertex shader uniforms data length

int TK_Custom_Shader::m_pixel_uniforms_data_length[TKO_Custom_Shader_Primitive_Count]

protected

int

internal use; Custom shader pixel shader uniforms data length