OffscreenRef

public struct OffscreenRef : OffscreenProtocol

The OffscreenRef type acts as a lightweight Swift reference to an underlying CoglOffscreen instance. It exposes methods that can operate on this data type through OffscreenProtocol conformance. Use OffscreenRef only as an unowned reference to an existing CoglOffscreen instance.

Show on GitHub
  • ptr 
    Untyped pointer to the underlying `CoglOffscreen` instance.

    For type-safe access, use the generated, typed pointer offscreen_ptr property instead.

    Declaration

    Swift

    public let ptr: UnsafeMutableRawPointer!
    Show on GitHub

Offscreen Class

  • Designated initialiser from the underlying C data type

    Declaration

    Swift

    @inlinable
init(_ p: UnsafeMutablePointer<CoglOffscreen>)
    Show on GitHub

  • Designated initialiser from a constant pointer to the underlying C data type

    Declaration

    Swift

    @inlinable
init(_ p: UnsafePointer<CoglOffscreen>)
    Show on GitHub

  • Conditional initialiser from an optional pointer to the underlying C data type

    Declaration

    Swift

    @inlinable
init!(_ maybePointer: UnsafeMutablePointer<CoglOffscreen>?)
    Show on GitHub

  • Conditional initialiser from an optional, non-mutable pointer to the underlying C data type

    Declaration

    Swift

    @inlinable
init!(_ maybePointer: UnsafePointer<CoglOffscreen>?)
    Show on GitHub

  • Conditional initialiser from an optional gpointer

    Declaration

    Swift

    @inlinable
init!(gpointer g: gpointer?)
    Show on GitHub

  • Conditional initialiser from an optional, non-mutable gconstpointer

    Declaration

    Swift

    @inlinable
init!(gconstpointer g: gconstpointer?)
    Show on GitHub

  • Reference intialiser for a related type that implements OffscreenProtocol

    Declaration

    Swift

    @inlinable
init<T>(_ other: T) where T : OffscreenProtocol
    Show on GitHub

  • Unsafe typed initialiser. Do not use unless you know the underlying data type the pointer points to conforms to OffscreenProtocol.

    Declaration

    Swift

    @inlinable
init<T>(cPointer: UnsafeMutablePointer<T>)
    Show on GitHub

  • Unsafe typed initialiser. Do not use unless you know the underlying data type the pointer points to conforms to OffscreenProtocol.

    Declaration

    Swift

    @inlinable
init<T>(constPointer: UnsafePointer<T>)
    Show on GitHub

  • Unsafe untyped initialiser. Do not use unless you know the underlying data type the pointer points to conforms to OffscreenProtocol.

    Declaration

    Swift

    @inlinable
init(mutating raw: UnsafeRawPointer)
    Show on GitHub

  • Unsafe untyped initialiser. Do not use unless you know the underlying data type the pointer points to conforms to OffscreenProtocol.

    Declaration

    Swift

    @inlinable
init(raw: UnsafeMutableRawPointer)
    Show on GitHub

  • Unsafe untyped initialiser. Do not use unless you know the underlying data type the pointer points to conforms to OffscreenProtocol.

    Declaration

    Swift

    @inlinable
init(opaquePointer: OpaquePointer)
    Show on GitHub 
  • 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.

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

    new_to_texture is deprecated: Use cogl_offscreen_new_with_texture instead.

    Declaration

    Swift

    @available(*, deprecated)
@inlinable
init<TextureT>(to_texture texture: TextureT) where TextureT : TextureProtocol
    Show on GitHub

  • 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.

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

    The storage for the framebuffer is actually allocated lazily so this function will never return nil 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.

    Declaration

    Swift

    @inlinable
init<TextureT>(texture: TextureT) where TextureT : TextureProtocol
    Show on GitHub

  • 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.

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

    new_to_texture is deprecated: Use cogl_offscreen_new_with_texture instead.

    Declaration

    Swift

    @available(*, deprecated)
@inlinable
static func newTo<TextureT>(to_texture texture: TextureT) -> OffscreenRef! where TextureT : TextureProtocol
    Show on GitHub

  • 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.

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

    The storage for the framebuffer is actually allocated lazily so this function will never return nil 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.

    Declaration

    Swift

    @inlinable
static func newWith<TextureT>(texture: TextureT) -> OffscreenRef! where TextureT : TextureProtocol
    Show on GitHub