diguyGraphicsShaderInstance.h

Go to the documentation of this file.

/****************************************************************************
 * Copyright (c) 2024 MAK Technologies, Inc.
 * All rights reserved.
 ****************************************************************************/

/*********************************************************************/
#ifndef __diguyGraphicsShaderInstance_H
#define __diguyGraphicsShaderInstance_H

#ifdef SWIG
%module diguyGraphicsShaderInstance
#else
#define CPLUSPLUS_ONLY
#endif

#ifdef CPLUSPLUS_ONLY
#include <diguy_constants.h>
#include <declspec_diguy.h>

class diguyGraphicsShaderProgram;
class diguyGraphicsShaderTechnique;
class diguyGraphicsShaderInstance;
class diguyCharacter;
class bdiShaderProgramInstance;

/****************************************************************************/

#endif


/****************************************************************************/
class BDI_DECLSPEC_diguy diguyGraphicsShaderInstance
{

public:

/*****************************************************************************/
   /*l
    *b  Description:
    **
    **    This function returns the shader technique this shader instance is
    **    associated with.
    **
    *b  Returns:
    **
    **    pointer to type diguyGraphicsShaderTechnique; should never be NULL
    */
   diguyGraphicsShaderTechnique* get_shader_technique();


   /*l
    *b  Description:
    **
    **    This function returns a pointer to the character that this shader
    **    instance is associated with.
    **
    *b  Returns:
    **
    **    pointer to type diguyCharacter; may be NULL
    */
   diguyCharacter* get_character();


/*****************************************************************************/
#ifdef CPLUSPLUS_ONLY

   /*l
    *b  Description:
    **
    **    This function will be called by DI-Guy when it is time for the
    **    object that this shader instance is attached to to be rendered.
    **    This happens during the Draw Stage, just before the geometry of a
    **    character or scene object is to be rendered.
    **
    **    Any instance level shader control variables should be set in this
    **    function.  Instance level variables will affect only shader
    **    operations in which this instance is active.  Variables that
    **    should affect the overall program of a shader should be set in
    **    diguyGraphicsShaderProgram::bind().
    **
    *i  Immediate Mode:
    **
    **    Immediate mode renderers usually do override this function.
    **
    *i  Scene Graph:
    **
    **    Scene graph renderers usually do not override this function; the
    **    renderer will typically do this internally.  If shader variables
    **    need to be bound, however, this function should be overridden.
    **
    *b  Callable From:
    **
    *-    - N/A (automatically called by DI-Guy Graphics API during
    *-      the Draw Stage)
    */
   virtual int bind();

   /*l
    *b  Description:
    **
    **    This function will be called by DI-Guy when the object this shader
    **    is attached to is done being rendered.
    **
    **    This happens during the Draw Stage, just after the geometry of a
    **    character has been rendered.
    **
    **    Any shader variables bound in bind() should be unbound here.
    **
    *i  Immediate Mode:
    **
    **    Immediate mode renderers usually do override this function.
    **
    *i  Scene Graph:
    **
    **    Scene graph renderers usually do not override this function; the
    **    renderer will typically do this internally.  If the bind()
    **    function was overridden, however, this function probably should
    **    be, too.
    **
    *b  Callable From:
    **
    *-    - N/A (automatically called by DI-Guy Graphics API during
    *-      the Draw Stage)
    */
   virtual int unbind();

#endif


/*****************************************************************************/
   int get_num_variables();
   const char* get_variable_name_at_index(int index);
   int has_variable(const char* name);
   const char* get_variable_type(const char* name);

   void reset_variables_to_initial_values();
   void reset_variables_to_program_defaults();

   int set_variable_float(const char* name, float value, int set_current = 1, int set_initial = 0, float blend_time = 0.0f);
   int set_variable_vec2(const char* name, float x, float y, int set_current = 1, int set_initial = 0, float blend_time = 0.0f);
   int set_variable_vec3(const char* name, float x, float y, float z, int set_current = 1, int set_initial = 0, float blend_time = 0.0f);
   int set_variable_vec4(const char* name, float x, float y, float z, float w, int set_current = 1, int set_initial = 0, float blend_time = 0.0f);
   int set_variable_int(const char* name, int value, int set_current = 1, int set_initial = 0);

   int get_variable_float(const char* name, float* value, int get_current = 1);
   int get_variable_vec2(const char* name, float* x, float* y, int get_current = 1);
   int get_variable_vec3(const char* name, float* x, float* y, float* z, int get_current = 1);
   int get_variable_vec4(const char* name, float* r, float* g, float* b, float* a, int get_current = 1);
   int get_variable_int(const char* name, int* value, int get_current = 1);


/****************************************************************************/
/****************************************************************************/
/****************************************************************************/
   /*l
    *b  Deprecated Functions: changed due to API restructuring
    **
    **    This function returns the shader program this shader instance is
    **    associated with.
    **
    *b  Returns:
    **
    **    pointer to type diguyGraphicsShaderProgram; should never be NULL
    */
   diguyGraphicsShaderProgram* get_shader_program();



#ifdef CPLUSPLUS_ONLY
   bdiShaderProgramInstance* get_internal_data() {return m_internal_data;}

protected:

   /*l
    **    A protected constructor.  Constructors are called automatically
    **    by DI-Guy.
    */
   diguyGraphicsShaderInstance(void* internal_data);

   /*l
    **    A protected destructor.  Destructors are called automatically
    **    by DI-Guy.
    */
   virtual ~diguyGraphicsShaderInstance();

private:

   /*l
    **    A pointer to internal data.
    */
   bdiShaderProgramInstance* m_internal_data;

   friend class bdiShaderProgramInstance;
   friend class bdiGeometryFactory;
#endif
};


#endif /* __diguyGraphicsShaderInstance_H */