renderbuffer.h

Go to the documentation of this file.

/**
 * \file mi32/renderbuffer.h
 * \brief RENDERBUFFER class definition
 *
 * \if NODOC
 * $Id: renderbuffer.h_v 1.6 2005/07/06 22:44:03 vdronov Exp $
 *
 * $Log: renderbuffer.h_v $
 * Revision 1.6  2005/07/06 22:44:03  vdronov
 * *** empty log message ***
 *
 * Revision 1.5  2005/06/15 22:07:10  mju
 * Add interlaceFromDevice.
 *
 * Revision 1.4  2005/05/24 21:29:18  mju
 * Unify overlayOnDevice with optional cliprect.
 *
 * Revision 1.3  2005/05/24 17:54:37  mju
 * Add ability to set plane masks for use when overlay.
 *
 * Revision 1.2  2005/05/03 20:29:45  mju
 * Add overlayOnDevice variant using rectangle.
 *
 * Revision 1.1  2005/04/22 17:34:41  mju
 * Initial revision
 *
 * \endif
**/

#ifndef  INC_MI32_RENDERBUFFER_H
#define  INC_MI32_RENDERBUFFER_H

#ifndef INC_MI32_RECT_H
#include <mi32/rect.h>
#endif

#ifndef INC_MI32_COLORSPC_H
#include <mi32/colorspc.h>
#endif

#ifndef INC_MI32_MXSTEREO_H
#include <mi32/mxstereo.h>
#endif


namespace MGD {
   class DEVICE;
   class DEVICE_MEM32RGBA;
   }

//===================================================================================================================

//! General memory-based rendering buffer.
//! Supports creation/copying from and overlay on other MGD devices.
class RENDERBUFFER {
   public:

      //! Get target colorspace suitable for overlay.
      static COLORSPACE GetTargetColorSpace (
         const MGD::DEVICE *pDeviceRef             //!< Reference device
         );

      //! Constructor.
      RENDERBUFFER ();

      //! Destructor.
      ~RENDERBUFFER ();

      //! Copy rendering from specified source device.
      //! Created device will have same (virtual) size and colorspace as source.
      //! If successful will set as having been rendered.
      ERRVALUE CopyFromDevice (
         const MGD::DEVICE_MEM32RGBA *pDevSource,  //!< Source device to copy from
         bool UseMinimalRectangle = true,          //!< Use minimal rectangle
         bool CopyDepth = false
         );

      //! Destroy device buffer if any.
      void DestroyDevice (
         );

      //! Get rendering device (non-const).
      //! @return Device pointer, NULL if not yet created.
      MGD::DEVICE* GetDevice (
         );

      //! Get rendering device (const).
      //! @return Device pointer, NULL if not yet created.
      const MGD::DEVICE* GetDevice (
         ) const;

      //! Determine if has been rendered.
      bool HasRendered (
         ) const { return (m_pDevice != 0 && m_HasRendered); }

      //! Interlace left/right stereo views.
      ERRVALUE InterlaceFromDevice (
         MGD::DEVICE_MEM32RGBA *pDevSource,        //!< Source device to copy from
         const LRECT2D& SrcRectLeft,               //!< Source rectangle for left view
         const LRECT2D& SrcRectRight,              //!< Source rectangle for right view
         STEREOMODE StereoMode,                    //!< Stereo mode
         bool UseMinimalRectangle = true           //!< Use minimal rectangle
         );

      //! Overlay rendered buffer on specified device using rectangle.
      void OverlayOnDevice (
         MGD::DEVICE *pDevTarget,               //!< Target device to overlay on
         const LRECT2D *pClipRect = 0           //!< Optional limiting rectangle
         ) const;

      //! Set to use all planes when overlaying.
      void SetPlaneMaskAll (
         ) { m_MaskRed = m_MaskGreen = m_MaskBlue = 255; }

      //! Set to only use specific color planes when overlaying.
      void SetPlaneMaskRGB (
         UINT8 MaskRed,
         UINT8 MaskGreen,
         UINT8 MaskBlue
         ) { m_MaskRed = MaskRed; m_MaskGreen = MaskGreen; m_MaskBlue = MaskBlue; }

      //! Set whether current rendering is valid or not.
      void SetRendered (
         bool HasRendered                       //!< True to mark as valid, false to mark as invalid
         ) { m_HasRendered = HasRendered; }

      //! Setup device.
      //! Existing rendering will be lost.
      //! Created device will have same size and colorspace as specified reference.
      ERRVALUE SetupDevice (
         const MGD::DEVICE *pDeviceRef          //!< Reference device for determining size and colorspace
         );

   private:
      #ifndef GENERATING_DOXYGEN_OUTPUT
      MGD::DEVICE_MEM32RGBA *m_pDevice;
      bool m_HasRendered;                       // Has been rendered
      LRECT2D m_ValidRect;                      // Portion of virtual rendering space which is valid
      UINT8 m_MaskRed;
      UINT8 m_MaskGreen;
      UINT8 m_MaskBlue;

      void CopyRect (MGD::DEVICE *pDevTarget, const MGD::DEVICE *pDevSource, bool UseTransp, const LRECT2D *pClipRect) const;
      void CopyDepthRect (MGD::DEVICE *pDevTarget, const MGD::DEVICE *pDevSource, const LRECT2D *pClipRect) const;

      // Unimplemented
      RENDERBUFFER (const RENDERBUFFER&);
      RENDERBUFFER& operator= (const RENDERBUFFER&);

      #endif // GENERATING_DOXYGEN_OUTPUT
   };

//===================================================================================================================


#endif   // INC_MI32_RENDERBUFFER_H

---