Copyright	Will Thompson Iñaki García Etxebarria and Jonas Platte
License	LGPL-2.1
Maintainer	Iñaki García Etxebarria
Safe Haskell	None
Language	Haskell2010

GI.Gdk.Objects.CairoContext

Contents

Exported types
Methods
- Overloaded methods
- cairoCreate

Description

CairoContext is an object representing the platform-specific draw context.

GdkCairoContexts are created for a Display using surfaceCreateCairoContext, and the context can then be used to draw on that Surface.

Synopsis

newtype CairoContext = CairoContext (ManagedPtr CairoContext)
class (GObject o, IsDescendantOf CairoContext o) => IsCairoContext o
toCairoContext :: (MonadIO m, IsCairoContext o) => o -> m CairoContext
noCairoContext :: Maybe CairoContext
cairoContextCairoCreate :: (HasCallStack, MonadIO m, IsCairoContext a) => a -> m (Maybe Context)

Exported types

newtype CairoContext Source #

Memory-managed wrapper type.

Constructors

CairoContext (ManagedPtr CairoContext)

Instances

Instances details

Eq CairoContext Source #
Instance details Defined in GI.Gdk.Objects.CairoContext Methods (==) :: CairoContext -> CairoContext -> Bool # (/=) :: CairoContext -> CairoContext -> Bool #
GObject CairoContext Source #
Instance details Defined in GI.Gdk.Objects.CairoContext Methods gobjectType :: IO GType #
IsGValue CairoContext Source #	Convert `CairoContext` to and from `GValue` with `toGValue` and `fromGValue`.
Instance details Defined in GI.Gdk.Objects.CairoContext Methods toGValue :: CairoContext -> IO GValue # fromGValue :: GValue -> IO CairoContext #
HasParentTypes CairoContext Source #
Instance details Defined in GI.Gdk.Objects.CairoContext
type ParentTypes CairoContext Source #
Instance details Defined in GI.Gdk.Objects.CairoContext type ParentTypes CairoContext = '[DrawContext, Object]

class (GObject o, IsDescendantOf CairoContext o) => IsCairoContext o Source #

Type class for types which can be safely cast to CairoContext, for instance with toCairoContext.

Instances

Instances details

(GObject o, IsDescendantOf CairoContext o) => IsCairoContext o Source #
Instance details Defined in GI.Gdk.Objects.CairoContext

toCairoContext :: (MonadIO m, IsCairoContext o) => o -> m CairoContext Source #

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

noCairoContext :: Maybe CairoContext Source #

A convenience alias for Nothing :: Maybe CairoContext.

Methods

Overloaded methods

cairoCreate

cairoContextCairoCreate Source #

Arguments

:: (HasCallStack, MonadIO m, IsCairoContext a)
=> a	`self`: a `CairoContext` that is currently drawing
-> m (Maybe Context)	Returns: a Cairo context to be used to draw the contents of the `Surface`. `Nothing` is returned when `contet` is not drawing.

Retrieves a Cairo context to be used to draw on the Surface of context. A call to drawContextBeginFrame with this context must have been done or this function will return Nothing.

The returned context is guaranteed to be valid until drawContextEndFrame is called.