diguyGraphicsShaderInstance.h

Go to the documentation of this file.

/*
 *  Copyright (C) 1992-2013 Boston Dynamics
 *  ALL RIGHTS RESERVED.
 *
 *  These coded instructions, statements, and computer programs
 *  contain unpublished proprietary information of Boston Dynamics
 *  and are protected by Copyright Laws of the United States.
 *  They may not be used, duplicated, or disclosed in any form, in
 *  whole or in part, without the prior written consent from Boston
 *  Dynamics.
 *
 *  RESTRICTED RIGHTS LEGEND
 *  Use, duplication, or disclosure by the government is subject
 *  to restrictions as set forth in FAR 52.227.19(c)(2) or
 *  subparagraph (c)(1)(ii) of the Rights in Technical Data and
 *  Computer Software clause at DFARS 252.227-7013 and/or in
 *  similar or successor clauses in the FAR, or the DOD or NASA
 *  FAR Supplement, or to subparagraphs (c)(1) and (c)(2) of the
 *  Commercial Computer Software--Restricted Rights at 48 CFR
 *  52.227-19, as applicable.  Unpublished-rights reserved under
 *  the Copyright Laws of the United States.
 *  Contractor/Manufacturer is:
 *  Boston Dynamics/78 Fourth Avenue/Waltham MA 02451.
 */

/*********************************************************************/
#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
         **
         *b  Callable From:
         **
         *-    - C++
         */
        diguyGraphicsShaderTechnique* get_shader_technique();


#ifdef CPLUSPLUS_ONLY

        /*l
         *b  Description:
         **
         **    This function returns a pointer to shader matrix data.  This is
         **    the same pointer that is passed into bind_link_matrices().
         **
         **    The returned pointer should not be cached for later used, as it
         **    may change multiple times during the lifetime of this shader
         **    instance.
         **
         *b  Returns:
         **
         **    pointer to first value in array of floats
         **
         *b  Callable From:
         **
         *-    - C++
         */
        const float* get_shader_matrix_data_ptr();

#endif

        /*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
         **
         *b  Callable From:
         **
         *-    - C++
         */
        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
         **
         *b  Callable From:
         **
         *-    - C++
         */
        diguyGraphicsShaderProgram* get_shader_program();
/****************************************************************************/
/****************************************************************************/
/****************************************************************************/

        /*l
         *b  Description:
         **
         **    This function has been deprecated.  Skinned matrices are now bound
         **    at a per shape level.
         **
         **    This function returns the number of link matrices this instance
         **    needs to support.  This is useful to know when requesting
         **    resources during shader initialization (e.g., requesting uniform
         **    variable space).
         **
         **    This same number will be passed to update_link_matrices() and
         **    bind_link_matrices().
         **
         *b  Returns:
         **
         **    number of link matrices needed by this shader instance
         **
         *b  Callable From:
         **
         *-    - C++
         */
        int get_num_link_matrices();

        /*l
         *b  Description:
         **
         **    This function has been deprecated as of DI-Guy 12.  Skinned
         **    matrices are now updated at a per shape level.
         **
         **    This function will be called by DI-Guy when the matrix data of
         **    a character's links needs to be updated.  Scene graph renderers
         **    will queue up this data to be sent to the graphics card at the
         **    appropriate time.
         **
         **    Note that the format of the data in mat_data will be affected by
         **    the bdiGraphicsInitGraphicsAPI variable
         **    transpose_shader_matrices value.
         **
         *i  Immediate Mode:
         **
         **    Immediate mode renderers usually do not override this function,
         **    but instead use bind_link_matrices() during the Draw Stage.
         **
         *i  Scene Graph:
         **
         **    Scene graph renderers usually do override this function.
         **
         *b  Callable From:
         **
         *-    - N/A (automatically called by DI-Guy Graphics API during
         *-      the Update Stage)
         */
        virtual int update_link_matrices(int num_matrices,
                const float* mat_data);

#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 */