OGLFramebuffer (object)

For an OGLFramebuffer, the container version is the name and number of attachments. The value version is the size, and the types / bufferIDs of the individual attachments. It doesn’t reflect the pixel data value version of the individual buffers.

OGLFramebuffer OGLFramebuffer OGLFramebuffer OGLBaseObject OGLBaseObject OGLFramebuffer->OGLBaseObject BaseVersioned BaseVersioned OGLBaseObject->BaseVersioned OGLObject OGLObject OGLBaseObject->OGLObject StatisticSourceWithAutoRegisterMember StatisticSourceWithAutoRegisterMember OGLBaseObject->StatisticSourceWithAutoRegisterMember Versioned Versioned BaseVersioned->Versioned

Members

Versions version  
String name  
UInt32 bufferID  
UInt32 unactiveBufferID  
Boolean externallyOwned  
OGLWrapperGlobals wrapperGlobals  
StatisticsAutoRegisterMember autoStats  
Size width  
OGLFramebuffer_attachment[] colors  
OGLFramebuffer_attachment depth  
UInt32 activeStateVersion  
OGLFramebuffer_perContextData[] perContextData  

Methods

  OGLFramebuffer ( in OGLFramebuffer other )
  OGLFramebuffer ()
Boolean activate ! ( in UInt32 target, io Ref<OGLContext> context )
Boolean activate ! ( in UInt32 target, io Ref<OGLContext> context, io OGLFramebuffer_perContextData contextData )
  activateAllDefinedColors ! ( io Ref<OGLContext> context )
  clearAllColors ! ( in Color color, io Ref<OGLContext> context )
  clearColor ! ( in Size index, in Color color, in Boolean noMask, io Ref<OGLContext> context )
  clearDepth ! ( in Scalar depth, in Boolean noMask, io Ref<OGLContext> context )
  clearDepthStencil ! ( in Scalar depth, in UInt32 stencil, in Boolean noMask, io Ref<OGLContext> context )
  clearInteger ! ( in Size index, in SInt32 values[4], in Boolean noMask, io Ref<OGLContext> context )
  clearUnsignedInteger ! ( in Size index, in UInt32 values[4], in Boolean noMask, io Ref<OGLContext> context )
OGLFramebuffer clone ? ()
Boolean create ! ( io Ref<OGLContext> context )
UInt32 getColorActiveLayerOrCubeFace ? ( in UInt32 index )
UInt32 getColorActiveMipmapLevel ? ( in UInt32 index )
Ref<OGLImageObject> getColorAttachment ? ( in Size index )
Size getColorAttachmentCount ? ()
Size getColorAttachmentIndex ? ( in String name )
String getColorAttachmentName ? ( in Size index )
  getColorFormat ? ( in UInt32 index, io UInt32 glComponentType, io UInt32 redBits, io UInt32 greenBits, io UInt32 blueBits, io UInt32 alphaBits )
UInt32 getDepthActiveLayerOrCubeFace ? ()
UInt32 getDepthActiveMipmapLevel ? ( in UInt32 index )
Ref<OGLImageObject> getDepthAttachment ? ()
String getDepthAttachmentName ? ()
  getDepthFormat ? ( io UInt32 glComponentType, io UInt32 depthBits, io UInt32 stencilBits )
  incrementColorAttachmentValueVersion ? ( in Size index )
  incrementDepthAttachmentValueVersion ? ()
Boolean isColorAttachmentShared ? ( in Size index )
Boolean isColorCubeMapped ? ( in UInt32 index )
Boolean isColorLayered ? ( in UInt32 index )
Boolean isColorTexture ? ( in UInt32 index )
Boolean isDepthCubeMapped ? ()
Boolean isDepthLayered ? ()
Boolean isDepthTexture ? ()
UInt32 pushColorRenderbufferAttachment ! ( in String name, in UInt32 glInternalFormat )
UInt32 pushColorTextureAttachment ! ( in String name, in Boolean isShadow, in UInt32 glTextureType, in UInt32 glFormat, in UInt32 glInternalFormat )
  removeColorAttachment ! ( in UInt32 index )
  setColorActiveLayerOrCubeFace ! ( in UInt32 index, in UInt32 layer )
  setColorActiveMipmapLevel ! ( in UInt32 index, in UInt32 level )
  setColorAttachmentCount ! ( in Size count )
  setColorAttachmentDepth ! ( in UInt32 index, in Size depth )
  setColorAttachmentName ! ( in UInt32 index, in String name )
  setColorRenderbufferAttachment ! ( in UInt32 index, in String name, in UInt32 glInternalFormat )
  setColorTextureAttachment ! ( in UInt32 index, in String name, in Boolean isShadow, in UInt32 glTextureType, in UInt32 glFormat, in UInt32 glInternalFormat )
  setDepthActiveLayerOrCubeFace ! ( in UInt32 layer )
  setDepthActiveMipmapLevel ! ( in UInt32 level )
  setDepthAttachmentDepth ! ( in Size depth )
  setDepthAttachmentName ! ( in String name )
  setDepthRenderbufferAttachment ! ( in UInt32 glInternalFormat )
  setDepthTextureAttachment ! ( in Boolean shadow, in UInt32 glTextureType, in UInt32 glFormat, in UInt32 glInternalFormat )
  setSharedColorAttachment ! ( in UInt32 index, in String name, in Ref<OGLImageObject> attachment )
  setSize ! ( in Size width, in Size height )
  setSize ! ( in Size width, in Size height, in Size samples )
  ~OGLFramebuffer ()

Methods in detail

OGLFramebuffer ( in OGLFramebuffer other )

copy constructor

OGLFramebuffer ()

Boolean OGLFramebuffer.activate! ( in UInt32 target, io Ref<OGLContext> context )

Boolean OGLFramebuffer.activate! ( in UInt32 target, io Ref<OGLContext> context, io OGLFramebuffer_perContextData contextData )

OGLFramebuffer.activateAllDefinedColors! ( io Ref<OGLContext> context )

OGLFramebuffer.clearAllColors! ( in Color color, io Ref<OGLContext> context )

OGLFramebuffer.clearColor! ( in Size index, in Color color, in Boolean noMask, io Ref<OGLContext> context )

Note: this will modify the DrawBuffers, unless color attachment ‘index’ is defined as a draw buffer in stateCache

OGLFramebuffer.clearDepth! ( in Scalar depth, in Boolean noMask, io Ref<OGLContext> context )

OGLFramebuffer.clearDepthStencil! ( in Scalar depth, in UInt32 stencil, in Boolean noMask, io Ref<OGLContext> context )

OGLFramebuffer.clearInteger! ( in Size index, in SInt32 values[4], in Boolean noMask, io Ref<OGLContext> context )

OGLFramebuffer.clearUnsignedInteger! ( in Size index, in UInt32 values[4], in Boolean noMask, io Ref<OGLContext> context )

OGLFramebuffer OGLFramebuffer.clone? ()

clone method

Boolean OGLFramebuffer.create! ( io Ref<OGLContext> context )

Returns true if it succeeded. Some Objects can only be created with specialized methods, in which case this will return false.

UInt32 OGLFramebuffer.getColorActiveLayerOrCubeFace? ( in UInt32 index )

UInt32 OGLFramebuffer.getColorActiveMipmapLevel? ( in UInt32 index )

Ref<OGLImageObject> OGLFramebuffer.getColorAttachment? ( in Size index )

Size OGLFramebuffer.getColorAttachmentCount? ()

Size OGLFramebuffer.getColorAttachmentIndex? ( in String name )

Returns UInt32Max if not found

String OGLFramebuffer.getColorAttachmentName? ( in Size index )

OGLFramebuffer.getColorFormat? ( in UInt32 index, io UInt32 glComponentType, io UInt32 redBits, io UInt32 greenBits, io UInt32 blueBits, io UInt32 alphaBits )

UInt32 OGLFramebuffer.getDepthActiveLayerOrCubeFace? ()

UInt32 OGLFramebuffer.getDepthActiveMipmapLevel? ( in UInt32 index )

Ref<OGLImageObject> OGLFramebuffer.getDepthAttachment? ()

String OGLFramebuffer.getDepthAttachmentName? ()

OGLFramebuffer.getDepthFormat? ( io UInt32 glComponentType, io UInt32 depthBits, io UInt32 stencilBits )

OGLFramebuffer.incrementColorAttachmentValueVersion? ( in Size index )

OGLFramebuffer.incrementDepthAttachmentValueVersion? ()

Boolean OGLFramebuffer.isColorAttachmentShared? ( in Size index )

Boolean OGLFramebuffer.isColorCubeMapped? ( in UInt32 index )

Boolean OGLFramebuffer.isColorLayered? ( in UInt32 index )

Boolean OGLFramebuffer.isColorTexture? ( in UInt32 index )

Boolean OGLFramebuffer.isDepthCubeMapped? ()

Boolean OGLFramebuffer.isDepthLayered? ()

Boolean OGLFramebuffer.isDepthTexture? ()

UInt32 OGLFramebuffer.pushColorRenderbufferAttachment! ( in String name, in UInt32 glInternalFormat )

UInt32 OGLFramebuffer.pushColorTextureAttachment! ( in String name, in Boolean isShadow, in UInt32 glTextureType, in UInt32 glFormat, in UInt32 glInternalFormat )

OGLFramebuffer.removeColorAttachment! ( in UInt32 index )

OGLFramebuffer.setColorActiveLayerOrCubeFace! ( in UInt32 index, in UInt32 layer )

OGLFramebuffer.setColorActiveMipmapLevel! ( in UInt32 index, in UInt32 level )

OGLFramebuffer.setColorAttachmentCount! ( in Size count )

OGLFramebuffer.setColorAttachmentDepth! ( in UInt32 index, in Size depth )

OGLFramebuffer.setColorAttachmentName! ( in UInt32 index, in String name )

OGLFramebuffer.setColorRenderbufferAttachment! ( in UInt32 index, in String name, in UInt32 glInternalFormat )

OGLFramebuffer.setColorTextureAttachment! ( in UInt32 index, in String name, in Boolean isShadow, in UInt32 glTextureType, in UInt32 glFormat, in UInt32 glInternalFormat )

OGLFramebuffer.setDepthActiveLayerOrCubeFace! ( in UInt32 layer )

OGLFramebuffer.setDepthActiveMipmapLevel! ( in UInt32 level )

OGLFramebuffer.setDepthAttachmentDepth! ( in Size depth )

OGLFramebuffer.setDepthAttachmentName! ( in String name )

OGLFramebuffer.setDepthRenderbufferAttachment! ( in UInt32 glInternalFormat )

OGLFramebuffer.setDepthTextureAttachment! ( in Boolean shadow, in UInt32 glTextureType, in UInt32 glFormat, in UInt32 glInternalFormat )

OGLFramebuffer.setSharedColorAttachment! ( in UInt32 index, in String name, in Ref<OGLImageObject> attachment )

OGLFramebuffer.setSize! ( in Size width, in Size height )

OGLFramebuffer.setSize! ( in Size width, in Size height, in Size samples )

~ OGLFramebuffer ()