Gjsify LogoGjsify Logo

Hierarchy

  • Offscreen

Index

Constructors

Properties

name: string

Methods

  • This creates an offscreen buffer object using the given texture as the primary color buffer. It doesn't just initialize the contents of the offscreen buffer with the texture; they are tightly bound so that drawing to the offscreen buffer effectivly updates the contents of the given texture. You don't need to destroy the offscreen buffer before you can use the texture again.

    This only works with low-level #CoglTexture types such as #CoglTexture2D, #CoglTexture3D and #CoglTextureRectangle, and not with meta-texture types such as #CoglTexture2DSliced.

    Parameters

    Returns Cogl.Offscreen

  • This creates an offscreen framebuffer object using the given texture as the primary color buffer. It doesn't just initialize the contents of the offscreen buffer with the texture; they are tightly bound so that drawing to the offscreen buffer effectively updates the contents of the given texture. You don't need to destroy the offscreen buffer before you can use the texture again.

    This api only works with low-level #CoglTexture types such as #CoglTexture2D, #CoglTexture3D and #CoglTextureRectangle, and not with meta-texture types such as #CoglTexture2DSliced.

    The storage for the framebuffer is actually allocated lazily so this function will never return %NULL to indicate a runtime error. This means it is still possible to configure the framebuffer before it is really allocated.

    Simple applications without full error handling can simply rely on Cogl to lazily allocate the storage of framebuffers but you should be aware that if Cogl encounters an error (such as running out of GPU memory) then your application will simply abort with an error message. If you need to be able to catch such exceptions at runtime then you can explicitly allocate your framebuffer when you have finished configuring it by calling cogl_framebuffer_allocate() and passing in a #CoglError argument to catch any exceptions.

    Parameters

    Returns Cogl.Offscreen

  • ref(offscreen: object): object
  • Increments the reference count on the offscreen framebuffer.

    Parameters

    • offscreen: object

      A pointer to a #CoglOffscreen framebuffer

    Returns object

  • unref(offscreen: object): void
  • Decreases the reference count for the offscreen buffer and frees it when the count reaches 0.

    Parameters

    • offscreen: object

      A pointer to a #CoglOffscreen framebuffer

    Returns void

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Type alias with type parameter
  • Enumeration
  • Enumeration member
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Constructor
  • Property
  • Method
  • Index signature
  • Class
  • Class with type parameter
  • Constructor
  • Property
  • Method
  • Accessor
  • Index signature
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Protected property
  • Protected method
  • Protected accessor
  • Private property
  • Private method
  • Private accessor
  • Static property
  • Static method