Source/System/Window/FrameBufferObjects/OSGFrameBufferAttachment.h

   1 /*---------------------------------------------------------------------------*\
   2  *                                OpenSG                                     *
   3  *                                                                           *
   4  *                                                                           *
   5  *             Copyright (C) 2000-2002 by the OpenSG Forum                   *
   6  *                                                                           *
   7  *                            www.opensg.org                                 *
   8  *                                                                           *
   9  *   contact: dirk@opensg.org, gerrit.voss@vossg.org, jbehr@zgdv.de          *
  10  *                                                                           *
  11 \*---------------------------------------------------------------------------*/
  12 /*---------------------------------------------------------------------------*\
  13  *                                License                                    *
  14  *                                                                           *
  15  * This library is free software; you can redistribute it and/or modify it   *
  16  * under the terms of the GNU Library General Public License as published    *
  17  * by the Free Software Foundation, version 2.                               *
  18  *                                                                           *
  19  * This library is distributed in the hope that it will be useful, but       *
  20  * WITHOUT ANY WARRANTY; without even the implied warranty of                *
  21  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU         *
  22  * Library General Public License for more details.                          *
  23  *                                                                           *
  24  * You should have received a copy of the GNU Library General Public         *
  25  * License along with this library; if not, write to the Free Software       *
  26  * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.                 *
  27  *                                                                           *
  28 \*---------------------------------------------------------------------------*/
  29 /*---------------------------------------------------------------------------*\
  30  *                                Changes                                    *
  31  *                                                                           *
  32  *                                                                           *
  33  *                                                                           *
  34  *                                                                           *
  35  *                                                                           *
  36  *                                                                           *
  37 \*---------------------------------------------------------------------------*/
  38
  39 #ifndef _OSGFRAMEBUFFERATTACHMENT_H_
  40 #define _OSGFRAMEBUFFERATTACHMENT_H_
  41 #ifdef __sgi
  42 #pragma once
  43 #endif
  44
  45 #include "OSGFrameBufferAttachmentBase.h"
  46
  47 OSG_BEGIN_NAMESPACE
  48
  49 class RenderActionBase;
  50 class DrawEnv;
  51 class FrameBufferObject;
  52
  53 /*! \brief Viewport class for color channel selection. See \ref
  54     PageSystemFBOBuffer for a description.
  55     \ingroup GrpSystemWindowFBOObj
  56     \ingroup GrpLibOSGSystem
  57     \includebasedoc
  58  */
  59
  60 class OSG_SYSTEM_DLLMAPPING FrameBufferAttachment :
  61     public FrameBufferAttachmentBase
  62 {
  63   private:
  64
  65     /*==========================  PUBLIC  =================================*/
  66
  67   public:
  68
  69     typedef FrameBufferAttachmentBase                           Inherited;
  70
  71     /*---------------------------------------------------------------------*/
  72     /*! \name                      Sync                                    */
  73     /*! \{                                                                 */
  74
  75     virtual void changed(ConstFieldMaskArg whichField,
  76                          UInt32            origin,
  77                          BitVector         detail);
  78
  79     /*! \}                                                                 */
  80     /*---------------------------------------------------------------------*/
  81     /*! \name                     Output                                   */
  82     /*! \{                                                                 */
  83
  84     virtual void dump(      UInt32     uiIndent = 0,
  85                       const BitVector  bvFlags  = 0) const;
  86
  87     /*! \}                                                                 */
  88     /*---------------------------------------------------------------------*/
  89     /*! \name                    your_category                             */
  90     /*! \{                                                                 */
  91
  92     virtual void bind    (DrawEnv *pEnv, UInt32 index = 0) = 0;
  93     virtual void validate(DrawEnv *pEnv                  ) = 0;
  94
  95     /*! \}                                                                 */
  96     /*---------------------------------------------------------------------*/
  97     /*! \name                    your_category                             */
  98     /*! \{                                                                 */
  99
 100     virtual GLenum getBufferFormat(void) const = 0;
 101
 102     /*! \}                                                                 */
 103     /*---------------------------------------------------------------------*/
 104     /*! \name                    your_category                             */
 105     /*! \{                                                                 */
 106
 107     virtual void processPreDeactivate (DrawEnv *pEnv, UInt32 index) = 0;
 108     virtual void processPostDeactivate(DrawEnv *pEnv              ) = 0;
 109
 110     /*! \}                                                                 */
 111     /*=========================  PROTECTED  ===============================*/
 112
 113   protected:
 114
 115     // Variables should all be in FrameBufferAttachmentBase.
 116
 117     /*---------------------------------------------------------------------*/
 118     /*! \name                  Constructors                                */
 119     /*! \{                                                                 */
 120
 121     FrameBufferAttachment(void);
 122     FrameBufferAttachment(const FrameBufferAttachment &source);
 123
 124     /*! \}                                                                 */
 125     /*---------------------------------------------------------------------*/
 126     /*! \name                   Destructors                                */
 127     /*! \{                                                                 */
 128
 129     virtual ~FrameBufferAttachment(void);
 130
 131     /*! \}                                                                 */
 132     /*---------------------------------------------------------------------*/
 133     /*! \name                        size                                  */
 134     /*! \{                                                                 */
 135
 136             void resize       (UInt32 uiWidth, UInt32 uiHeight);
 137     virtual void resizeBuffers(UInt32 uiWidth, UInt32 uiHeight) = 0;
 138
 139     /*! \}                                                                 */
 140     /*---------------------------------------------------------------------*/
 141     /*! \name                       Init                                   */
 142     /*! \{                                                                 */
 143
 144     static void initMethod(InitPhase ePhase);
 145
 146     /*! \}                                                                 */
 147     /*==========================  PRIVATE  ================================*/
 148
 149   private:
 150
 151     friend class FieldContainer;
 152     friend class FrameBufferAttachmentBase;
 153     friend class FrameBufferObject;
 154
 155     // prohibit default functions (move to 'public' if you need one)
 156     void operator =(const FrameBufferAttachment &source);
 157 };
 158
 159 typedef FrameBufferAttachment *FrameBufferAttachmentP;
 160
 161 OSG_END_NAMESPACE
 162
 163 #include "OSGFrameBufferAttachmentBase.inl"
 164 #include "OSGFrameBufferAttachment.inl"
 165
 166 #endif /* _OSGFRAMEBUFFERATTACHMENT_H_ */