Introduction

Getting Started

Programming Guides

API Reference

Additional Resources

Begin_Shader_Search

Functions

void Begin_Shader_Search (void)
 These routines recall the name of each shader. More...
 
void Begin_Shader_Search_By_Key (HC_KEY key)
 Starts a shader search beginning at the segment associated with the passed key. More...
 
void End_Shader_Search (void)
 Terminates the shader search sequence and frees any involved memory. More...
 
HC_BOOLEAN Find_Shader (char *sname)
 Retrieves the shader names, one at a time. The function returns false when all shaders have been returned. More...
 

Detailed Description

Function Documentation

void Begin_Shader_Search ( void  )

These routines recall the name of each shader.

DETAILS

This set of routines allows the user to "dump" all the shaders that exist in the database. It returns only the shader names. To find the details for each shader use Show_Shader() . For example


            Begin_Shader_Search ()
            while (Find_Shader (shader)) 
            {
                Show_Shader (shader, def, source) 
                print (shader, def, source) 
            } 
            End_Shader_Search ()

prints all the known shader names, their options and source. Begin_Shader_Search() initiates the search for each shader name.

Find_Shader() retrieves the shader names, one at a time. The function returns false when all shaders have been returned.

End_Shader_Search() terminates the sequence and frees any involved memory.

NOTES

If an shader search is in progress and an shader becomes undefined via UnDefine_Shader(), it will not be returned by subsequent calls to Find_Shader(). If a shader is added, it will not be returned until the next shader search is begun.

See also
Show_Shader, Define_Shader
void Begin_Shader_Search_By_Key ( HC_KEY  key)

Starts a shader search beginning at the segment associated with the passed key.

Parameters
key- The unique identifier to a specific segment.

DETAILS

No additional details. See Begin_Shader_Search().

void End_Shader_Search ( void  )

Terminates the shader search sequence and frees any involved memory.

DETAILS

No additional details. See Begin_Shader_Search().

HC_BOOLEAN Find_Shader ( char *  sname)

Retrieves the shader names, one at a time. The function returns false when all shaders have been returned.

Parameters
sname- One shader name. Returned to user. Passed by reference always.
Returns
True or flase. The funciton returns false when all shaders have been returned.

DETAILS

No additional details. See Begin_Shader_Search().