gi-cogl-1.0.5: COGL GObject bindings
CopyrightWill Thompson and Iñaki García Etxebarria
LicenseLGPL-2.1
MaintainerIñaki García Etxebarria
Safe HaskellSafe-Inferred
LanguageHaskell2010

GI.Cogl.Objects.Offscreen

Description

No description available in the introspection data.

Synopsis

Exported types

newtype Offscreen Source #

Memory-managed wrapper type.

Constructors

Offscreen (ManagedPtr Offscreen) 

Instances

Instances details
Eq Offscreen Source # 
Instance details

Defined in GI.Cogl.Objects.Offscreen

BoxedPtr Offscreen Source # 
Instance details

Defined in GI.Cogl.Objects.Offscreen

ManagedPtrNewtype Offscreen Source # 
Instance details

Defined in GI.Cogl.Objects.Offscreen

Methods

toManagedPtr :: Offscreen -> ManagedPtr Offscreen

TypedObject Offscreen Source # 
Instance details

Defined in GI.Cogl.Objects.Offscreen

Methods

glibType :: IO GType

HasParentTypes Offscreen Source # 
Instance details

Defined in GI.Cogl.Objects.Offscreen

type ParentTypes Offscreen Source # 
Instance details

Defined in GI.Cogl.Objects.Offscreen

type ParentTypes Offscreen = '[] :: [Type]

class (BoxedPtr o, TypedObject o, IsDescendantOf Offscreen o) => IsOffscreen o Source #

Type class for types which can be safely cast to Offscreen, for instance with toOffscreen.

Instances

Instances details
(BoxedPtr o, TypedObject o, IsDescendantOf Offscreen o) => IsOffscreen o Source # 
Instance details

Defined in GI.Cogl.Objects.Offscreen

toOffscreen :: (MonadIO m, IsOffscreen o) => o -> m Offscreen Source #

Cast to Offscreen, for types for which this is known to be safe. For general casts, use castTo.

Methods

newToTexture

offscreenNewToTexture Source #

Arguments

:: (HasCallStack, MonadIO m, IsTexture a) 
=> a

texture: A CoglTexture pointer

-> m Offscreen

Returns: a newly instantiated Offscreen framebuffer or Nothing if it wasn't possible to create the buffer.

Deprecated: (Since version 1.16)Use cogl_offscreen_new_with_texture instead.

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>

newWithTexture

offscreenNewWithTexture Source #

Arguments

:: (HasCallStack, MonadIO m, IsTexture a) 
=> a

texture: A CoglTexture pointer

-> m Offscreen

Returns: a newly instantiated Offscreen framebuffer.

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

ref

offscreenRef Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> Ptr ()

offscreen: A pointer to a Offscreen framebuffer

-> m (Ptr ())

Returns: For convenience it returns the given offscreen

Deprecated: (Since version 1.2)cogl_object_ref() should be used in new code.

Increments the reference count on the offscreen framebuffer.

unref

offscreenUnref Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> Ptr ()

offscreen: A pointer to a Offscreen framebuffer

-> m () 

Deprecated: (Since version 1.2)cogl_object_unref() should be used in new code.

Decreases the reference count for the offscreen buffer and frees it when the count reaches 0.