RE/RE_OGLState.h

Go to the documentation of this file.

/*
 * PROPRIETARY INFORMATION.  This software is proprietary to
 * Side Effects Software Inc., and is not to be reproduced,
 * transmitted, or disclosed in any way without written permission.
 *
 * Produced by:
 *      Mark Alexander
 *      Side Effects
 *      123 Front Street West, Suite 1401
 *      Toronto, Ontario
 *      Canada   M5J 2M2
 *      416-504-9876
 *
 * NAME:        RE_OGLState.h ( UI Library, C++)
 *
 * COMMENTS:
 *      The stored GL state for RE_OGLRender.
 *
 */
#ifndef RE_OGLState_h
#define RE_OGLState_h

#include "RE_API.h"
#include "RE_Types.h"
#include "RE_TextureTypes.h"
#include "RE_Uniform.h"

#include <UT/UT_Rect.h>
#include <UT/UT_RefArray.h>

class RE_OGLFramebuffer;
class RE_OGLTexture;
class RE_Shader;

class RE_API RE_OGLState
{
public:
                 RE_OGLState(bool list_state);
                ~RE_OGLState();

    bool         isListState() const { return myDisplayListState; }
    void         invalidate();
    void         raiseAssertsForStateDifferences(const RE_OGLState &state);
    void         verifySync();

    void         pushColorBuf();
    void         pushEnable();
    void         pushCurrent();
    void         pushFog();
    void         pushHint();
    void         pushDepthBuf();
    void         pushLines();
    void         pushLighting();
    void         pushPointStyle();
    void         pushPolygon();
    void         pushStencilBuf();
    void         pushTexture();
    void         pushViewport();

    unsigned int getPushedBits() const { return myPushedBits; }

// State data
    GLint               _matrixMode;
    int                 _colorBufferWriting;

    // 0 = disabled, 1 = enabled, 3 = state is unknown
    unsigned
        myAlphaTestState : 2,
        myColorMaterialState : 2,
        myDepthCueingState :2,
        myDepthTestState : 2,
        myDitherState : 2,
        myFillOffsetState : 2,
        myLightingState : 2,
        myLineOffsetState : 2,
        myLineSmoothingState : 2,
        myPointOffsetState : 2,
        myPointSmoothingState : 2,
        myScissorState : 2,
        myStencilState : 2,
        mySeamlessMapState : 2;

    unsigned    concave:2,
                backface:2,
                reverse_winding:2;

    float        wPosX, wPosY, wPosZ;
    float        rx, ry, rz;

    UT_DimRect   scissorState;
    UT_DimRect   viewportState;

    bool         scissorEnabled;

    int          viewportStateValid;
    int          scissorStateValid;

    float        myXZoom, myYZoom;

    float        zNear, zFar;
    float        _offset_variable;
    float        _offset_constant;


    unsigned     lightingOn:2;
    RE_InterpMode myShadeModel;
    unsigned     myColorMask;

    RE_ZFunction         _z_function;
    int                  _s_clear_value;
    int                  _s_write_mask;
    RE_SFunction         _s_function;
    int                  _s_function_ref;
    int                  _s_function_mask;
    RE_SOperation        _s_operation_sfail;
    RE_SOperation        _s_operation_dpfail;
    RE_SOperation        _s_operation_dppass;
    
    // Stacks
    RE_OGLFramebuffer  *myDrawFBOStack[RE_FRAMEBUFFER_STACK_SIZE];
    int                 myDrawFBOStackIndex;
    RE_OGLFramebuffer  *myReadFBOStack[RE_FRAMEBUFFER_STACK_SIZE];
    int                 myReadFBOStackIndex;
    
    RE_CMMatrix    projectionStack[PROJECTION_STACK_SIZE];
    int            projectionIndex;
    float          lineWidthStack[PATTERN_STACK_SIZE];
    int            lineWidthIndex;
    unsigned short lineStyleStack[PATTERN_STACK_SIZE];
    int            lineStyleIndex;
    short          patternStack[PATTERN_STACK_SIZE];
    int            patternIndex;
    RE_ColorStack  colorStack[RE_COLOR_STACK_SIZE];
    int            colorStackIndex;
    float          pointSizeStack[PATTERN_STACK_SIZE];
    int            pointSizeIndex;

    struct
    {
        unsigned char read:4,
                     write:4;
    } myAlignmentStack[RE_ALIGN_STACK_SIZE];
    int            myAlignmentStackIndex;
        
    float          myGLColor[4];
    
    // These are the state caches for our mulitple texture units:
    struct re_TexStackItem
    {
        int      myActiveUnit;
        int      myRestoreUnit;
        
        struct re_TexUnit
        {
            RE_OGLTexture *texture;
            unsigned type : 4,  // RE_TextureDimension
                     mode : 4,  // RE_TextureMode
                     texcoords:1; // texture coords adjusted
        } myUnits[RE_MAX_TEXTURES];
        
    } myTexStack[RE_MAX_TEXTURE_STATE_STACK];

    int                 myTexStackIndex;
    
    // smooth lines stack
    int                 myBlendSmoothLevel;
    re_BlendSmoothState myBlendSmoothStack[RE_SMOOTH_STACK_SIZE];

    // stenciling stack
    int                 myStencilLevel;
    re_StencilState     myStencilStack[RE_STENCIL_STACK_SIZE];

    // shader stack
    int                 myShaderLevel;
    RE_Shader          *myShaderStack[RE_SHADER_STACK_SIZE];

    unsigned            myShaderStackValid : 1,
                        myFBOStackValid : 1;

private:
    bool                myDisplayListState;

    // for the list state, bits pushed by glPushAttrib().
    unsigned    myPushedBits;
    
    void         privPushColorBuf();
    void         privPushEnable();
    void         privPushCurrent();
    void         privPushFog();
    void         privPushHint();
    void         privPushDepthBuf();
    void         privPushLines();
    void         privPushLighting();
    void         privPushPointStyle();
    void         privPushPolygon();
    void         privPushStencilBuf();
    void         privPushTexture();
    void         privPushViewport();
};

#define IMPL_INLINE_PUSH(name)                  \
inline void RE_OGLState::push##name()           \
{ if(myDisplayListState) privPush##name(); }

IMPL_INLINE_PUSH(ColorBuf);
IMPL_INLINE_PUSH(Enable);
IMPL_INLINE_PUSH(Current);
IMPL_INLINE_PUSH(Fog);
IMPL_INLINE_PUSH(Hint);
IMPL_INLINE_PUSH(DepthBuf);
IMPL_INLINE_PUSH(Lines);
IMPL_INLINE_PUSH(Lighting);
IMPL_INLINE_PUSH(PointStyle);
IMPL_INLINE_PUSH(Polygon);
IMPL_INLINE_PUSH(StencilBuf);
IMPL_INLINE_PUSH(Texture);
IMPL_INLINE_PUSH(Viewport);

#endif

---