GLScene.h

#import <Cocoa/Cocoa.h>
#import <OpenGL/OpenGL.h>
#import <OpenGL/CGLMacro.h>
#import <VVBasics/VVBasics.h>
#import "VVBuffer.h"




extern OSSpinLock       _glSceneStatLock;
extern NSMutableArray   *_gpuVendorArray;
extern BOOL             _integratedGPUFlag; //  whether or not the scene is rendering on an integrated GPU
extern BOOL             _nvidiaGPUFlag; //  whether or not the scene is rendering on an NVIDIA GPU

typedef enum    {
    VVGLFlushModeGL = 0,    //  glFlush()
    VVGLFlushModeCGL = 1,   //  CGLFlushDrawable()
    VVGLFlushModeNS = 2,    //  [context flushBuffer]
    VVGLFlushModeApple = 3, //  glFlushRenderAPPLE()
    VVGLFlushModeFinish = 4 //  glFinish()
} VVGLFlushMode;




@interface GLScene : NSObject {
    BOOL                    deleted;
    BOOL                    initialized;
    BOOL                    needsReshape;
    OSSpinLock              renderThreadLock;   //  used to serialize access to "renderThreadDeleteArray", making it thread-safe
    MutLockArray            *renderThreadDeleteArray;   //  NOT RETAINED!  weak ref to an array you can add items to such that the items will be released on the thread that renders the scene.  useful if you need to ensure that rendering resources are released on the same thread that did the rendering.  only non-nil if this scene is being rendered on a thread created by a RenderThread class
    
    NSOpenGLContext         *sharedContext; //  NOT retained! weak ref to the shared context, which is assumed to be retained elsewhere.
    NSOpenGLContext         *context;   //  RETAINED- the context i render into!
    NSOpenGLPixelFormat     *customPixelFormat; //  the pixel format used by my context
    CGColorSpaceRef         colorSpace;
    
    id                      renderTarget;   //  NOT RETAINED- the target of my render method
    SEL                     renderSelector; //  this method gets called when i render; ONLY does the actual drawing- does NOT do setup/cleanup (use _renderPrep and _renderCleanup)!
    
    GLuint                  fbo;    //  the framebuffer my context renders into- only valid when the render method is called!
    GLuint                  tex;    //  the fbo renders into this texture- only valid when the render method is called!
    GLuint                  texTarget;  //  either GL_TEXTURE_RECTANGLE_EXT or GL_TEXTURE_2D.  both 'tex' and 'depth' much be using this target!
    GLuint                  depth;  //  the depth buffer for context- only valid when the render method is called!
    
    GLuint                  fboMSAA;    //  this fbo has renderbuffers which support MSAA attached to it- only valid when the render method is called!
    GLuint                  colorMSAA;  //  the color renderbuffer attached to the msaa fbo- only valid when the render method is called!
    GLuint                  depthMSAA;  //  the depth renderbuffer attached to the msaa fbo- only valid when the render method is called!
    
    NSSize                  size;   //  the size of the this scene/the texture/framebuffer/viewport/etc
    BOOL                    flipped;    //  whether or not the context renders upside-down.  NO by default, but some subclasses just render upside-down...
    
    BOOL                    performClear;
    GLfloat                 clearColor[4];
    BOOL                    clearColorUpdated;
    VVGLFlushMode           flushMode;  //  0=glFlush(), 1=CGLFlushDrawable(), 2=[context flushBuffer]
    int                     swapInterval;
}

+ (NSMutableArray *) gpuVendorArray;
+ (BOOL) integratedGPUFlag;
+ (BOOL) nvidiaGPUFlag;
+ (GLuint) glDisplayMaskForAllScreens;
+ (NSOpenGLPixelFormat *) defaultPixelFormat;
+ (NSOpenGLPixelFormat *) doubleBufferPixelFormat;
+ (NSOpenGLPixelFormat *) defaultQTPixelFormat;
+ (NSOpenGLPixelFormat *) fsaaPixelFormat;
+ (NSOpenGLPixelFormat *) doubleBufferFSAAPixelFormat;

- (id) initWithSharedContext:(NSOpenGLContext *)c;
- (id) initWithSharedContext:(NSOpenGLContext *)c sized:(NSSize)s;
- (id) initWithSharedContext:(NSOpenGLContext *)c pixelFormat:(NSOpenGLPixelFormat *)p;
- (id) initWithSharedContext:(NSOpenGLContext *)c pixelFormat:(NSOpenGLPixelFormat *)p sized:(NSSize)s;
- (void) prepareToBeDeleted;

- (VVBuffer *) allocAndRenderABuffer;
- (void) render;
- (void) renderInFBO:(GLuint)f colorTex:(GLuint)t depthTex:(GLuint)d;
- (void) renderInMSAAFBO:(GLuint)mf colorRB:(GLuint)mc depthRB:(GLuint)md fbo:(GLuint)f colorTex:(GLuint)t depthTex:(GLuint)d;

- (void) renderInMSAAFBO:(GLuint)mf colorRB:(GLuint)mc depthRB:(GLuint)md fbo:(GLuint)f colorTex:(GLuint)t depthTex:(GLuint)d target:(GLuint)texTarget;
- (void) renderBlackFrameInFBO:(GLuint)f colorTex:(GLuint)t target:(GLuint)tt;
- (void) renderOpaqueBlackFrameInFBO:(GLuint)f colorTex:(GLuint)t target:(GLuint)tt;
- (void) renderRedFrameInFBO:(GLuint)f colorTex:(GLuint)t target:(GLuint)tt;
- (void) _renderPrep;
- (void) _initialize;
- (void) _reshape;
- (void) _renderCleanup;

- (NSOpenGLContext *) sharedContext;
- (NSOpenGLContext *) context;
- (CGLContextObj) CGLContextObj;
- (NSOpenGLPixelFormat *) customPixelFormat;
- (CGColorSpaceRef) colorSpace;
@property (assign,readwrite) NSSize size;
- (void) setFlipped:(BOOL)n;
- (BOOL) flipped;

- (void) setPerformClear:(BOOL)n;
- (void) setClearNSColor:(NSColor *)c;
- (void) setClearColor:(GLfloat *)c;
- (void) setClearColors:(GLfloat)r :(GLfloat)g :(GLfloat)b :(GLfloat)a;

@property (assign,readwrite) BOOL initialized;
@property (assign, readwrite) id renderTarget;
@property (assign, readwrite) SEL renderSelector;
@property (assign, readwrite) VVGLFlushMode flushMode;
@property (assign, readwrite) int swapInterval;

@end