gls_es20_effect_factory_interface.h

Go to the documentation of this file.

/*! \file
  \brief IGlsEffectFactory, interface to a factory for creating GlsEffect objects

  \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_EFFECT_FACTORY_INTERFACE_H_INCLUDED
#define DISTI_GLS_ES20_EFFECT_FACTORY_INTERFACE_H_INCLUDED

#include "gls_es20_effect.h"

namespace disti
{
/** \interface IGlsEffectFactory
  * The interface to a factory for creating GlsEffect objects.
  * Holds the standard and custom shaders, compiles effects,
  * and maintains a list of effects for quick access.
  */
class IGlsEffectFactory
{
public:
    /** type of shader features bitfield */
    typedef unsigned int ShaderBitfieldT;

    /** enumeration for bitfield describing shader capability */
    enum ShaderOptions_e
    {
        SHADER_LIGHTING_BIT            = 1 << 0,
        SHADER_CLIP_PLANES_BIT         = 1 << 1,
        SHADER_TEXTURE_BLEND_BIT       = 1 << 2,
        SHADER_TEXTURE_MODULATE_BIT    = 1 << 3,
        SHADER_TEXTURE_ALPHA_BIT       = 1 << 4,
        SHADER_TEXTURE_REPLACE_BIT     = 1 << 5,
        SHADER_TEXTURE_REPLACE_RGB_BIT = 1 << 6,
        SHADER_ALPHA_TEST_BIT          = 1 << 7,
        SHADER_TEXTURE_DECAL_BIT       = 1 << 8,

        SHADER_DIFFUSE_MAP_BIT = 1 << 10,
        SHADER_DIFFUSE_UVW_BIT = 1 << 11,

        SHADER_LIGHT_1_POINT = 1 << 20,
        SHADER_LIGHT_2_POINT = 1 << 21,
        SHADER_LIGHT_3_POINT = 1 << 22,
        SHADER_LIGHT_4_POINT = 1 << 23,
        SHADER_LIGHT_5_POINT = 1 << 24,
        SHADER_LIGHT_6_POINT = 1 << 25,
        SHADER_LIGHT_7_POINT = 1 << 26,
        SHADER_LIGHT_8_POINT = 1 << 27,

        SHADER_NUM_LIGHTS_FIELD_OFFSET = 28, // Field of 4 bits starting at the offset
        SHADER_NUM_LIGHTS_1            = 1 << SHADER_NUM_LIGHTS_FIELD_OFFSET,
        SHADER_NUM_LIGHTS_2            = 2 << SHADER_NUM_LIGHTS_FIELD_OFFSET,
        SHADER_NUM_LIGHTS_3            = 3 << SHADER_NUM_LIGHTS_FIELD_OFFSET,
        SHADER_NUM_LIGHTS_4            = 4 << SHADER_NUM_LIGHTS_FIELD_OFFSET,
        SHADER_NUM_LIGHTS_5            = 5 << SHADER_NUM_LIGHTS_FIELD_OFFSET,
        SHADER_NUM_LIGHTS_6            = 6 << SHADER_NUM_LIGHTS_FIELD_OFFSET,
        SHADER_NUM_LIGHTS_7            = 7 << SHADER_NUM_LIGHTS_FIELD_OFFSET,
        SHADER_NUM_LIGHTS_8            = 8 << SHADER_NUM_LIGHTS_FIELD_OFFSET
    };

    /** enumeration for bitfield describing max-like shader capability */
    enum MaxLikeShaderOptions_e
    {
        MAXLIKE_SHADER_VERTEX_COLOR_BIT = 1 << 9,

        MAXLIKE_SHADER_DIFFUSE_MAP_BIT    = 1 << 10,
        MAXLIKE_SHADER_DIFFUSE_UVW_BIT    = 1 << 11,
        MAXLIKE_SHADER_DIFFUSE_AMOUNT_BIT = 1 << 12,
        MAXLIKE_SHADER_NORMAL_MAP_BIT     = 1 << 13,
        MAXLIKE_SHADER_NORMAL_UVW_BIT     = 1 << 14,
        MAXLIKE_SHADER_NORMAL_AMOUNT_BIT  = 1 << 15,
        MAXLIKE_SHADER_NORMAL_FLIP_G_BIT  = 1 << 16,
        MAXLIKE_SHADER_SPECULAR_MAP_BIT   = 1 << 17,
        MAXLIKE_SHADER_SPECULAR_UVW_BIT   = 1 << 18,
        MAXLIKE_SHADER_REFLECTION_MAP_BIT = 1 << 19,

        MAXLIKE_SHADER_LIGHT_1_POINT = 1 << 20,
        MAXLIKE_SHADER_LIGHT_2_POINT = 1 << 21,
        MAXLIKE_SHADER_LIGHT_3_POINT = 1 << 22,
        MAXLIKE_SHADER_LIGHT_4_POINT = 1 << 23,
        MAXLIKE_SHADER_LIGHT_5_POINT = 1 << 24,
        MAXLIKE_SHADER_LIGHT_6_POINT = 1 << 25,
        MAXLIKE_SHADER_LIGHT_7_POINT = 1 << 26,
        MAXLIKE_SHADER_LIGHT_8_POINT = 1 << 27,

        MAXLIKE_SHADER_NUM_LIGHTS_FIELD_OFFSET = 28, // Field of 4 bits starting at the offset
        MAXLIKE_SHADER_NUM_LIGHTS_1            = 1 << MAXLIKE_SHADER_NUM_LIGHTS_FIELD_OFFSET,
        MAXLIKE_SHADER_NUM_LIGHTS_2            = 2 << MAXLIKE_SHADER_NUM_LIGHTS_FIELD_OFFSET,
        MAXLIKE_SHADER_NUM_LIGHTS_3            = 3 << MAXLIKE_SHADER_NUM_LIGHTS_FIELD_OFFSET,
        MAXLIKE_SHADER_NUM_LIGHTS_4            = 4 << MAXLIKE_SHADER_NUM_LIGHTS_FIELD_OFFSET,
        MAXLIKE_SHADER_NUM_LIGHTS_5            = 5 << MAXLIKE_SHADER_NUM_LIGHTS_FIELD_OFFSET,
        MAXLIKE_SHADER_NUM_LIGHTS_6            = 6 << MAXLIKE_SHADER_NUM_LIGHTS_FIELD_OFFSET,
        MAXLIKE_SHADER_NUM_LIGHTS_7            = 7 << MAXLIKE_SHADER_NUM_LIGHTS_FIELD_OFFSET,
        MAXLIKE_SHADER_NUM_LIGHTS_8            = 8 << MAXLIKE_SHADER_NUM_LIGHTS_FIELD_OFFSET
    };

    /** Return a standard effect with the parameters specified.
      * This method is called by the state manager automatically in response to standard draw calls.
      * \param[in] bitfield a bitfield indicating the shader features requested (\see ShaderOptions_e)
      * \returns An effect that meets the requirements of bitfield.
      */
    GLS_EXPORT virtual GlsEffect* GetStdEffect( ShaderBitfieldT bitfield ) = 0;

    /** Return a max-like effect with the parameters specified.
      * \param[in] bitfield a bitfield indicating the shader features requested (\see MaxLikeShaderOptions_e)
      * \returns An effect that meets the requirements of bitfield.
      */
    GLS_EXPORT virtual GlsEffect* GetMaxLikeEffect( ShaderBitfieldT bitfield ) = 0;

    /** Provide custom shaders to create a new effect.
      * \param[in] vertShader the vertex shader source
      * \param[in] fragShader the fragment shader source
      * \returns The effect's ID in the effect factory.
      */
    GLS_EXPORT virtual GlsEffect* CreateCustomEffect( const char* vertShader, const char* fragShader ) = 0;

protected:
    /** empty ctor */
    IGlsEffectFactory( void ) {}

    /** empty dtor */
    ~IGlsEffectFactory() {}
};

} // namespace disti

#endif // DISTI_GLS_ES20_EFFECT_FACTORY_INTERFACE_H_INCLUDED