TK_Custom_Shader_Sampler

Functions

	`TK_Custom_Shader_Sampler`
	`~TK_Custom_Shader_Sampler`
`TK_Status`	`Read`
`TK_Status`	`Write`
`TK_Status`	`Clone`
`TK_Status`	`ReadAscii`
`TK_Status`	`WriteAscii`
void	`Reset`
void	`SetName`
void	`SetName`
void	`SetFilter`
void	`SetMaxAnisotropy`
void	`SetLOD`
void	`SetAddress`
void	`SetBorderColor`
bool	`GetFilterString`
bool	`GetAddressString`
bool	`GetBorderColorString`

Detailed Description

class TK_Custom_Shader_Sampler : public BBaseOpcodeHandler

Handles the TKE_Custom_Shader_Sampler opcode.

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

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

Public Functions

TK_Custom_Shader_Sampler(): constructor

~TK_Custom_Shader_Sampler()

virtual TK_Status Read(BStreamFileToolkit &tk)

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.

virtual TK_Status Write(BStreamFileToolkit &tk)

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.

virtual TK_Status Clone(BStreamFileToolkit &tk, BBaseOpcodeHandler **handler) const

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 ReadAscii(BStreamFileToolkit &tk): Deprecated.

TK_Status WriteAscii(BStreamFileToolkit &tk): Deprecated.

virtual void Reset(): 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 SetName(char const *name): Sets the shader sampler name. Allocates the buffer and copies the shader sampler name string

void SetName(int length): Sets the shader sampler name buffer. Allocates a buffer large enough to hold a string of ‘length’ characters

void SetFilter(TKO_Custom_Shader_Sampler_Option_Bits filter, TKO_Custom_Shader_Sampler_Filter value): Sets the sampler filter

void SetMaxAnisotropy(int value): Sets the sampler max anisotropy

void SetLOD(TKO_Custom_Shader_Sampler_Option_Bits lod, float value): Sets the sampler lod

void SetAddress(TKO_Custom_Shader_Sampler_Option_Bits address, int value): Sets the sampler address

void SetBorderColor(int value): Sets the sampler border color

bool GetFilterString(TKO_Custom_Shader_Sampler_Filter filter_enum, char *filter): Gets the filter string

bool GetAddressString(TKO_Custom_Shader_Sampler_Address address_enum, char *address): Gets the address string

bool GetBorderColorString(TKO_Custom_Shader_Sampler_Border_Color_Value border_color_enum, char *border_color): Gets the border color string