gls_es20_uniform.h

Go to the documentation of this file.

/*! \file
  \brief Templated class to hold uniform data for ES20 effects.
 
  \par Copyright Information
 
  Copyright (c) 2017 by The DiSTI Corporation.<br>
  11301 Corporate Blvd; Suite 100<br>
  Orlando, Florida 32817<br>
  USA<br>
  <br>
  All rights reserved.<br>
 
  This Software contains proprietary trade secrets of DiSTI and may not be
reproduced, in whole or part, in any form, or by any means of electronic,
mechanical, or otherwise, without the written permission of DiSTI.  Said
permission may be derived through the purchase of applicable DiSTI product
licenses which detail the distribution rights of this content and any
Derivative Works based on this or other copyrighted DiSTI Software.
 
  NO WARRANTY. THE SOFTWARE IS PROVIDED "AS-IS," WITHOUT WARRANTY OF ANY KIND,
AND ANY USE OF THIS SOFTWARE PRODUCT IS AT YOUR OWN RISK. TO THE MAXIMUM EXTENT
PERMITTED BY APPLICABLE LAW, DISTI AND ITS SUPPLIERS DISCLAIM ALL WARRANTIES
AND CONDITIONS, EITHER EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
IMPLIED WARRANTIES AND CONDITIONS OF MERCHANTABILITY AND/OR FITNESS FOR A
PARTICULAR PURPOSE, TITLE, AND NON-INFRINGEMENT, WITH REGARD TO THE SOFTWARE.
 
  LIMITATION OF LIABILITY. TO THE MAXIMUM EXTENT PERMITTED BY APPLICABLE LAW,
IN NO EVENT SHALL DISTI OR ITS SUPPLIERS BE LIABLE FOR ANY SPECIAL, INCIDENTAL,
INDIRECT, OR CONSEQUENTIAL DAMAGES WHATSOEVER (INCLUDING, WITHOUT LIMITATION,
DAMAGES FOR LOSS OF BUSINESS PROFITS, BUSINESS INTERRUPTION, LOSS OF BUSINESS
INFORMATION, OR ANY OTHER PECUNIARY LOSS) ARISING OUT OF THE USE OF OR
INABILITY TO USE THE SOFTWARE, EVEN IF DISTI HAS BEEN ADVISED OF THE POSSIBILITY
OF SUCH DAMAGES.  DISTI'S ENTIRE LIABILITY AND YOUR EXCLUSIVE REMEDY SHALL NOT
EXCEED FIVE DOLLARS (US$5.00).
 
 The aforementioned terms and restrictions are governed by the laws of the
State of Florida and the United States of America. Use, distribution,
duplication, or disclosure by the U. S. Government is subject to
"Restricted Rights" as set forth in DFARS 252.227-7014(c)(1)(ii).
 
*/
 
#ifndef DISTI_GLS_ES20_UNIFORM_H_INCLUDED
#define DISTI_GLS_ES20_UNIFORM_H_INCLUDED
 
#include "gls_gl.h"
#include "gls_include.h"
 
namespace disti
{
/// \details The GlsUniform class. Wraps an OpenGL shader uniform.
class GlsUniform
{
public:
    /** Constructor. Sets the dirty flag and "invalid" uniform location.
      */
    GLS_EXPORT GlsUniform();
 
    /** Destructor. Does nothing.
      */
    GLS_EXPORT ~GlsUniform() {}
 
    /** Grabs the uniform location for this uniform from the program object.
      * \param[in] programObject The program that this uniform belongs to.
      * \param[in] name The name of the variable as provided to the shaders
      * \return The new uniform location, or -1 on failure.
      */
    GLS_EXPORT GLint SetUniformLocation( GLuint programObject, const GLchar* name );
 
    /** Set single integer uniform data.
      * \param[in] data The uniform value to set.
      */
    GLS_EXPORT void SetUniform1i( int data );
 
    /** Set two integer uniform data.
      * \param[in] data The uniform value to set.
      */
    GLS_EXPORT void SetUniform2i( int* data );
 
    /** Set three integer uniform data.
      * \param[in] data The uniform value to set.
      */
    GLS_EXPORT void SetUniform3i( int* data );
 
    /** Set four integer uniform data.
      * \param[in] data The uniform value to set.
      */
    GLS_EXPORT void SetUniform4i( int* data );
 
    /** Set single float uniform data.
      * \param[in] data The uniform value to set.
      */
    GLS_EXPORT void SetUniform1f( float data );
 
    /** Set two float uniform data.
      * \param[in] data The uniform value to set.
      */
    GLS_EXPORT void SetUniform2f( float* data );
 
    /** Set three float uniform data.
      * \param[in] data The uniform value to set.
      */
    GLS_EXPORT void SetUniform3f( float* data );
 
    /** Set four float uniform data.
      * \param[in] data The uniform value to set.
      */
    GLS_EXPORT void SetUniform4f( float* data );
 
    /** Set four float uniform data.
      * \param[in] x the first float value
      * \param[in] y the second float value
      * \param[in] z the third float value
      * \param[in] w the fourth float value
      */
    GLS_EXPORT void SetUniform4f( float x, float y, float z, float w );
 
    /** Set four float uniform data vectors.  Note that this method doesn't cache the old values,
      * since we would have to dynamically allocate the cache memory based on size. Therefore,
      * prefer SetUniform4f when just setting a single 4 float vector
      * \param[in] size the number of 4 float vectors to set
      * \param[in] data The uniform value to set.
      */
    GLS_EXPORT void SetUniform4fv( int size, float* data );
 
    /** Set 2x2 matrix uniform data.
      * \param[in] data The uniform value to set.
      */
    GLS_EXPORT void SetUniformMatrix2f( float* data );
 
    /** Set 3x3 matrix uniform data.
      * \param[in] data The uniform value to set.
      */
    GLS_EXPORT void SetUniformMatrix3f( float* data );
 
    /** Set 4x4 matrix uniform data.
      * \param[in] data The uniform value to set.
      */
    GLS_EXPORT void SetUniformMatrix4f( float* data );
 
    /** Mark this uniform as dirty, guaranteeing the uniform will be updated on the next set call.
      */
    GLS_EXPORT void SetDirtyFlag();
 
protected:
    /** The uniform location as provided by the shader program. Defaults to -1. */
    GLint _uniformLocation; // = -1;
 
    /** If true, the uniform data should be sent to the program object. Defaults to true. */
    bool _isDirty; // = true;
 
    /** Convenience Union for comparing data. */
    union
    {
        int   as1i;
        int   as2i[ 2 ];
        int   as3i[ 3 ];
        int   as4i[ 4 ];
        float as1f;
        float as2f[ 2 ];
        float as3f[ 3 ];
        float as4f[ 4 ];
        float asMat2[ 4 ];
        float asMat3[ 9 ];
        float asMat4[ 16 ];
    } _data;
};
 
} // namespace disti
 
#endif // DISTI_GLS_ES20_UNIFORM_H_INCLUDED