GI.Gdk.Objects.DrawingContext

DrawingContext is an object that represents the current drawing state of a Window.

It's possible to use a DrawingContext to draw on a Window via rendering API like Cairo or OpenGL.

A DrawingContext can only be created by calling windowBeginDrawFrame and will be valid until a call to windowEndDrawFrame.

DrawingContext is available since GDK 3.22

Exported types

newtype DrawingContext

Constructors

DrawingContext (ManagedPtr DrawingContext)

Instances

GObject DrawingContext

Methods

gobjectType :: DrawingContext -> IO GType

IsObject DrawingContext

IsDrawingContext DrawingContext

((~) * info (ResolveDrawingContextMethod t DrawingContext), MethodInfo * info DrawingContext p) => IsLabel t (DrawingContext -> p)

Methods

fromLabel :: Proxy# Symbol t -> DrawingContext -> p

((~) * info (ResolveDrawingContextMethod t DrawingContext), MethodInfo * info DrawingContext p) => IsLabelProxy t (DrawingContext -> p)

Methods

fromLabelProxy :: Proxy Symbol t -> DrawingContext -> p

HasAttributeList * DrawingContext

type AttributeList DrawingContext

type AttributeList DrawingContext

type SignalList DrawingContext

type SignalList DrawingContext

class GObject o => IsDrawingContext o

Instances

(GObject a, UnknownAncestorError Constraint DrawingContext a) => IsDrawingContext a

IsDrawingContext DrawingContext

toDrawingContext :: IsDrawingContext o => o -> IO DrawingContext

noDrawingContext :: Maybe DrawingContext

Methods

getCairoContext

data DrawingContextGetCairoContextMethodInfo

Instances

((~) * signature (m Context), MonadIO m, IsDrawingContext a) => MethodInfo * DrawingContextGetCairoContextMethodInfo a signature

Methods

overloadedMethod :: MethodProxy DrawingContextGetCairoContextMethodInfo a -> signature -> s

drawingContextGetCairoContext

Arguments

:: (HasCallStack, MonadIO m, IsDrawingContext a)

=> a

-> m Context

Returns: a Cairo context to be used to draw the contents of the Window. The context is owned by the DrawingContext and should not be destroyed

Retrieves a Cairo context to be used to draw on the Window that created the DrawingContext.

The returned context is guaranteed to be valid as long as the DrawingContext is valid, that is between a call to windowBeginDrawFrame and windowEndDrawFrame.

Since: 3.22

getClip

data DrawingContextGetClipMethodInfo

Instances

((~) * signature (m (Maybe Region)), MonadIO m, IsDrawingContext a) => MethodInfo * DrawingContextGetClipMethodInfo a signature

Methods

overloadedMethod :: MethodProxy DrawingContextGetClipMethodInfo a -> signature -> s

drawingContextGetClip

Arguments

:: (HasCallStack, MonadIO m, IsDrawingContext a)

=> a

context: a DrawingContext

-> m (Maybe Region)

Returns: a Cairo region

Retrieves a copy of the clip region used when creating the context.

Since: 3.22

getWindow

data DrawingContextGetWindowMethodInfo

Instances

((~) * signature (m Window), MonadIO m, IsDrawingContext a) => MethodInfo * DrawingContextGetWindowMethodInfo a signature

Methods

overloadedMethod :: MethodProxy DrawingContextGetWindowMethodInfo a -> signature -> s

drawingContextGetWindow

Arguments

:: (HasCallStack, MonadIO m, IsDrawingContext a)

=> a

context: a DrawingContext

-> m Window

Returns: a Window

Retrieves the window that created the drawing context.

Since: 3.22

isValid

data DrawingContextIsValidMethodInfo

Instances

((~) * signature (m Bool), MonadIO m, IsDrawingContext a) => MethodInfo * DrawingContextIsValidMethodInfo a signature

Methods

overloadedMethod :: MethodProxy DrawingContextIsValidMethodInfo a -> signature -> s

drawingContextIsValid

Arguments

:: (HasCallStack, MonadIO m, IsDrawingContext a)

=> a

context: a DrawingContext

-> m Bool

Returns: True if the context is valid

Checks whether the given DrawingContext is valid.

Since: 3.22

Properties

clip

data DrawingContextClipPropertyInfo

Instances

AttrInfo DrawingContextClipPropertyInfo

Associated Types

type AttrAllowedOps DrawingContextClipPropertyInfo :: [AttrOpTag]

type AttrSetTypeConstraint DrawingContextClipPropertyInfo :: * -> Constraint

type AttrBaseTypeConstraint DrawingContextClipPropertyInfo :: * -> Constraint

type AttrGetType DrawingContextClipPropertyInfo :: *

type AttrLabel DrawingContextClipPropertyInfo :: Symbol

type AttrOrigin DrawingContextClipPropertyInfo :: *

Methods

attrGet :: AttrBaseTypeConstraint DrawingContextClipPropertyInfo o => Proxy * DrawingContextClipPropertyInfo -> o -> IO (AttrGetType DrawingContextClipPropertyInfo)

attrSet :: (AttrBaseTypeConstraint DrawingContextClipPropertyInfo o, AttrSetTypeConstraint DrawingContextClipPropertyInfo b) => Proxy * DrawingContextClipPropertyInfo -> o -> b -> IO ()

attrClear :: AttrBaseTypeConstraint DrawingContextClipPropertyInfo o => Proxy * DrawingContextClipPropertyInfo -> o -> IO ()

attrConstruct :: (AttrBaseTypeConstraint DrawingContextClipPropertyInfo o, AttrSetTypeConstraint DrawingContextClipPropertyInfo b) => Proxy * DrawingContextClipPropertyInfo -> b -> IO (GValueConstruct o)

type AttrOrigin DrawingContextClipPropertyInfo

type AttrOrigin DrawingContextClipPropertyInfo = DrawingContext

type AttrLabel DrawingContextClipPropertyInfo

type AttrLabel DrawingContextClipPropertyInfo = "clip"

type AttrGetType DrawingContextClipPropertyInfo

type AttrGetType DrawingContextClipPropertyInfo = Maybe Region

type AttrBaseTypeConstraint DrawingContextClipPropertyInfo

type AttrBaseTypeConstraint DrawingContextClipPropertyInfo = IsDrawingContext

type AttrSetTypeConstraint DrawingContextClipPropertyInfo

type AttrSetTypeConstraint DrawingContextClipPropertyInfo = * ~ Region

type AttrAllowedOps DrawingContextClipPropertyInfo

type AttrAllowedOps DrawingContextClipPropertyInfo = (:) AttrOpTag AttrConstruct ((:) AttrOpTag AttrGet ((:) AttrOpTag AttrClear ([] AttrOpTag)))

constructDrawingContextClip :: IsDrawingContext o => Region -> IO (GValueConstruct o)

drawingContextClip :: AttrLabelProxy "clip"

getDrawingContextClip :: (MonadIO m, IsDrawingContext o) => o -> m (Maybe Region)

window

data DrawingContextWindowPropertyInfo

Instances

AttrInfo DrawingContextWindowPropertyInfo

Associated Types

type AttrAllowedOps DrawingContextWindowPropertyInfo :: [AttrOpTag]

type AttrSetTypeConstraint DrawingContextWindowPropertyInfo :: * -> Constraint

type AttrBaseTypeConstraint DrawingContextWindowPropertyInfo :: * -> Constraint

type AttrGetType DrawingContextWindowPropertyInfo :: *

type AttrLabel DrawingContextWindowPropertyInfo :: Symbol

type AttrOrigin DrawingContextWindowPropertyInfo :: *

Methods

attrGet :: AttrBaseTypeConstraint DrawingContextWindowPropertyInfo o => Proxy * DrawingContextWindowPropertyInfo -> o -> IO (AttrGetType DrawingContextWindowPropertyInfo)

attrSet :: (AttrBaseTypeConstraint DrawingContextWindowPropertyInfo o, AttrSetTypeConstraint DrawingContextWindowPropertyInfo b) => Proxy * DrawingContextWindowPropertyInfo -> o -> b -> IO ()

attrClear :: AttrBaseTypeConstraint DrawingContextWindowPropertyInfo o => Proxy * DrawingContextWindowPropertyInfo -> o -> IO ()

attrConstruct :: (AttrBaseTypeConstraint DrawingContextWindowPropertyInfo o, AttrSetTypeConstraint DrawingContextWindowPropertyInfo b) => Proxy * DrawingContextWindowPropertyInfo -> b -> IO (GValueConstruct o)

type AttrOrigin DrawingContextWindowPropertyInfo

type AttrOrigin DrawingContextWindowPropertyInfo = DrawingContext

type AttrLabel DrawingContextWindowPropertyInfo

type AttrLabel DrawingContextWindowPropertyInfo = "window"

type AttrGetType DrawingContextWindowPropertyInfo

type AttrGetType DrawingContextWindowPropertyInfo = Window

type AttrBaseTypeConstraint DrawingContextWindowPropertyInfo

type AttrBaseTypeConstraint DrawingContextWindowPropertyInfo = IsDrawingContext

type AttrSetTypeConstraint DrawingContextWindowPropertyInfo

type AttrSetTypeConstraint DrawingContextWindowPropertyInfo = IsWindow

type AttrAllowedOps DrawingContextWindowPropertyInfo

type AttrAllowedOps DrawingContextWindowPropertyInfo = (:) AttrOpTag AttrConstruct ((:) AttrOpTag AttrGet ((:) AttrOpTag AttrClear ([] AttrOpTag)))

constructDrawingContextWindow :: (IsDrawingContext o, IsWindow a) => a -> IO (GValueConstruct o)

drawingContextWindow :: AttrLabelProxy "window"

getDrawingContextWindow :: (MonadIO m, IsDrawingContext o) => o -> m Window