RE/RE_RasterWindow.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_RasterWindow.h
 *
 * COMMENTS:
 *      Allows for easy OpenGL rendering to a raster. This is a
 *  convenience class that combines all the elements required. To use:
 *
 *  RE_RasterWindow capture;
 *  PXL_Raster *image;
 *
 *  capture.begin(40, 40);
 *    // render a bunch of stuff in OGL to (0,0)->(39,39)
 *  image = capture.end();
 *  
 */
#ifndef RE_RASTER_WINDOW_H
#define RE_RASTER_WINDOW_H

class PXL_Raster;
class RE_Render;

#include "RE_API.h"
#include "RE_Types.h"
#include <PXL/PXL_Raster.h>

class re_PBuffer;

class RE_API RE_RasterWindow
{
public:
     RE_RasterWindow();
    ~RE_RasterWindow();

    // After calling begin() to initialize your drawing area, start
    // drawing using OpenGL to the area (0, 0) - (w-1, h-1). Returns NULL if
    // it is not possible to open a offscreen rendering area matching the type
    // specified.

    // Be sure to use the RE_Render * passed back from begin() until
    // end() is called. Note that 'type' determines the data format for the
    // raster returned in end(), and not the format of the window.
    //
    RE_Render  *begin(RE_Render *r, int w, int h,
                      PXL_DataFormat type = PXL_INT8,
                      bool alphatoo = true,
                      bool zbuffer = false,
                      bool stencil = false);
    
    // The raster will remain empty until end() is called. begin() and end()
    // must always be paired. This performs a GL wait, so you don't have to
    // flush or wait. You are responsible for ownership of the raster.
    //
    PXL_Raster *end();

private:
    re_PBuffer  *myPBuffer;
    RE_Render   *myRender;
    RE_Render   *myPrevRender;
    int          myPrevRenderCount;
    int          myWidth, myHeight;
    PXL_DataFormat myFormat;
    bool         myAlphaFlag;
    RE_RenderBuf myPrevBuffer;
};



#endif

---