GI.Gdk.Objects.Surface

A Surface is a (usually) rectangular region on the screen. It’s a low-level object, used to implement high-level objects such as GtkWindow or GtkDialog in GTK.

The surfaces you see in practice are either Toplevel or Popup, and those interfaces provide much of the required API to interact with these surfaces. Other, more specialized surface types exist, but you will rarely interact with them directly.

Exported types

newtype Surface

Memory-managed wrapper type.

Constructors

Surface (ManagedPtr Surface)

Instances

Eq Surface

Defined in GI.Gdk.Objects.Surface

Methods

(==) :: Surface -> Surface -> Bool

(/=) :: Surface -> Surface -> Bool

GObject Surface

Defined in GI.Gdk.Objects.Surface

ManagedPtrNewtype Surface

Defined in GI.Gdk.Objects.Surface

Methods

toManagedPtr :: Surface -> ManagedPtr Surface

TypedObject Surface

Defined in GI.Gdk.Objects.Surface

Methods

glibType :: IO GType

HasParentTypes Surface

Defined in GI.Gdk.Objects.Surface

IsGValue (Maybe Surface)

Convert Surface to and from GValue. See toGValue and fromGValue.

Defined in GI.Gdk.Objects.Surface

Methods

gvalueGType_ :: IO GType

gvalueSet_ :: Ptr GValue -> Maybe Surface -> IO ()

gvalueGet_ :: Ptr GValue -> IO (Maybe Surface)

type ParentTypes Surface

Defined in GI.Gdk.Objects.Surface

type ParentTypes Surface = '[Object]

class (GObject o, IsDescendantOf Surface o) => IsSurface o

Type class for types which can be safely cast to Surface, for instance with toSurface.

Instances

(GObject o, IsDescendantOf Surface o) => IsSurface o

Defined in GI.Gdk.Objects.Surface

toSurface :: (MonadIO m, IsSurface o) => o -> m Surface

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

Methods

Click to display all available methods, including inherited ones

Methods

beep, bindProperty, bindPropertyFull, createCairoContext, createGlContext, createSimilarSurface, createVulkanContext, destroy, forceFloating, freezeNotify, getv, hide, isDestroyed, isFloating, notify, notifyByPspec, queueRender, ref, refSink, requestLayout, runDispose, stealData, stealQdata, thawNotify, translateCoordinates, unref, watchClosure.

Getters

getCursor, getData, getDeviceCursor, getDevicePosition, getDisplay, getFrameClock, getHeight, getMapped, getProperty, getQdata, getScaleFactor, getWidth.

Setters

setCursor, setData, setDataFull, setDeviceCursor, setInputRegion, setOpaqueRegion, setProperty.

beep

surfaceBeep

Arguments

:: (HasCallStack, MonadIO m, IsSurface a)

=> a

surface: a toplevel Surface

-> m ()

Emits a short beep associated to surface in the appropriate display, if supported. Otherwise, emits a short beep on the display just as displayBeep.

createCairoContext

surfaceCreateCairoContext

Arguments

:: (HasCallStack, MonadIO m, IsSurface a)

=> a

surface: a Surface

-> m CairoContext

Returns: the newly created CairoContext

Creates a new CairoContext for rendering on surface.

createGlContext

surfaceCreateGlContext

Arguments

:: (HasCallStack, MonadIO m, IsSurface a)

=> a

surface: a Surface

-> m GLContext

Returns: the newly created GLContext, or Nothing on error (Can throw GError)

Creates a new GLContext matching the framebuffer format to the visual of the Surface. The context is disconnected from any particular surface or surface.

If the creation of the GLContext failed, error will be set.

Before using the returned GLContext, you will need to call gLContextMakeCurrent or gLContextRealize.

createSimilarSurface

surfaceCreateSimilarSurface

Arguments

:: (HasCallStack, MonadIO m, IsSurface a)

=> a

surface: surface to make new surface similar to

-> Content

content: the content for the new surface

-> Int32

width: width of the new surface

-> Int32

height: height of the new surface

-> m Surface

Returns: a pointer to the newly allocated surface. The caller owns the surface and should call cairo_surface_destroy() when done with it.

This function always returns a valid pointer, but it will return a pointer to a “nil” surface if other is already in an error state or any other error occurs.

Create a new surface that is as compatible as possible with the given surface. For example the new surface will have the same fallback resolution and font options as surface. Generally, the new surface will also use the same backend as surface, unless that is not possible for some reason. The type of the returned surface may be examined with cairo_surface_get_type().

Initially the surface contents are all 0 (transparent if contents have transparency, black otherwise.)

createVulkanContext

surfaceCreateVulkanContext

Arguments

:: (HasCallStack, MonadIO m, IsSurface a)

=> a

surface: a Surface

-> m VulkanContext

Returns: the newly created VulkanContext, or Nothing on error (Can throw GError)

Creates a new VulkanContext for rendering on surface.

If the creation of the VulkanContext failed, error will be set.

destroy

surfaceDestroy

Arguments

:: (HasCallStack, MonadIO m, IsSurface a)

=> a

surface: a Surface

-> m ()

Destroys the window system resources associated with surface and decrements surface's reference count. The window system resources for all children of surface are also destroyed, but the children’s reference counts are not decremented.

Note that a surface will not be destroyed automatically when its reference count reaches zero. You must call this function yourself before that happens.

getCursor

surfaceGetCursor

Arguments

:: (HasCallStack, MonadIO m, IsSurface a)

=> a

surface: a Surface

-> m (Maybe Cursor)

Returns: a Cursor, or Nothing. The returned object is owned by the Surface and should not be unreferenced directly. Use surfaceSetCursor to unset the cursor of the surface

Retrieves a Cursor pointer for the cursor currently set on the specified Surface, or Nothing. If the return value is Nothing then there is no custom cursor set on the specified surface, and it is using the cursor for its parent surface.

getDeviceCursor

surfaceGetDeviceCursor

Arguments

:: (HasCallStack, MonadIO m, IsSurface a, IsDevice b)

=> a

surface: a Surface.

-> b

device: a logical, pointer Device.

-> m (Maybe Cursor)

Returns: a Cursor, or Nothing. The returned object is owned by the Surface and should not be unreferenced directly. Use surfaceSetCursor to unset the cursor of the surface

Retrieves a Cursor pointer for the device currently set on the specified Surface, or Nothing. If the return value is Nothing then there is no custom cursor set on the specified surface, and it is using the cursor for its parent surface.

getDevicePosition

surfaceGetDevicePosition

Arguments

:: (HasCallStack, MonadIO m, IsSurface a, IsDevice b)

=> a

surface: a Surface.

-> b

device: pointer Device to query to.

-> m (Bool, Double, Double, [ModifierType])

Returns: True if the device is over the surface

Obtains the current device position in doubles and modifier state. The position is given in coordinates relative to the upper left corner of surface.

getDisplay

surfaceGetDisplay

Arguments

:: (HasCallStack, MonadIO m, IsSurface a)

=> a

surface: a Surface

-> m Display

Returns: the Display associated with surface

Gets the Display associated with a Surface.

getFrameClock

surfaceGetFrameClock

Arguments

:: (HasCallStack, MonadIO m, IsSurface a)

=> a

surface: surface to get frame clock for

-> m FrameClock

Returns: the frame clock

Gets the frame clock for the surface. The frame clock for a surface never changes unless the surface is reparented to a new toplevel surface.

getHeight

surfaceGetHeight

Arguments

:: (HasCallStack, MonadIO m, IsSurface a)

=> a

surface: a Surface

-> m Int32

Returns: The height of surface

Returns the height of the given surface.

Surface size is reported in ”application pixels”, not ”device pixels” (see surfaceGetScaleFactor).

getMapped

surfaceGetMapped

Arguments

:: (HasCallStack, MonadIO m, IsSurface a)

=> a

surface: a Surface

-> m Bool

Returns: True if the surface is mapped

Checks whether the surface has been mapped (with toplevelPresent or popupPresent).

getScaleFactor

surfaceGetScaleFactor

Arguments

:: (HasCallStack, MonadIO m, IsSurface a)

=> a

surface: surface to get scale factor for

-> m Int32

Returns: the scale factor

Returns the internal scale factor that maps from surface coordinates to the actual device pixels. On traditional systems this is 1, but on very high density outputs this can be a higher value (often 2).

A higher value means that drawing is automatically scaled up to a higher resolution, so any code doing drawing will automatically look nicer. However, if you are supplying pixel-based data the scale value can be used to determine whether to use a pixel resource with higher resolution data.

The scale of a surface may change during runtime.

getWidth

surfaceGetWidth

Arguments

:: (HasCallStack, MonadIO m, IsSurface a)

=> a

surface: a Surface

-> m Int32

Returns: The width of surface

Returns the width of the given surface.

Surface size is reported in ”application pixels”, not ”device pixels” (see surfaceGetScaleFactor).

hide

surfaceHide

Arguments

:: (HasCallStack, MonadIO m, IsSurface a)

=> a

surface: a Surface

-> m ()

For toplevel surfaces, withdraws them, so they will no longer be known to the window manager; for all surfaces, unmaps them, so they won’t be displayed. Normally done automatically as part of gtk_widget_hide().

isDestroyed

surfaceIsDestroyed

Arguments

:: (HasCallStack, MonadIO m, IsSurface a)

=> a

surface: a Surface

-> m Bool

Returns: True if the surface is destroyed

Check to see if a surface is destroyed..

newPopup

surfaceNewPopup

Arguments

:: (HasCallStack, MonadIO m, IsSurface a)

=> a

parent: the parent surface to attach the surface to

-> Bool

autohide: whether to hide the surface on outside clicks

-> m Surface

Returns: a new Surface

Create a new popup surface.

The surface will be attached to parent and can be positioned relative to it using popupPresent.

newToplevel

surfaceNewToplevel

Arguments

:: (HasCallStack, MonadIO m, IsDisplay a)

=> a

display: the display to create the surface on

-> m Surface

Returns: the new Surface

Creates a new toplevel surface.

queueRender

surfaceQueueRender

Arguments

:: (HasCallStack, MonadIO m, IsSurface a)

=> a

surface: a Surface

-> m ()

Forces a render signal emission for surface to be scheduled.

This function is useful for implementations that track invalid regions on their own.

requestLayout

surfaceRequestLayout

Arguments

:: (HasCallStack, MonadIO m, IsSurface a)

=> a

surface: a Surface

-> m ()

Request a FrameClockPhaseLayout from the surface's frame clock. See frameClockRequestPhase.

setCursor

surfaceSetCursor

Arguments

:: (HasCallStack, MonadIO m, IsSurface a, IsCursor b)

=> a

surface: a Surface

-> Maybe b

cursor: a cursor

-> m ()

Sets the default mouse pointer for a Surface.

Note that cursor must be for the same display as surface.

Use cursorNewFromName or cursorNewFromTexture to create the cursor. To make the cursor invisible, use GDK_BLANK_CURSOR. Passing Nothing for the cursor argument to surfaceSetCursor means that surface will use the cursor of its parent surface. Most surfaces should use this default.

setDeviceCursor

surfaceSetDeviceCursor

Arguments

:: (HasCallStack, MonadIO m, IsSurface a, IsDevice b, IsCursor c)

=> a

surface: a Surface

-> b

device: a logical, pointer Device

-> c

cursor: a Cursor

-> m ()

Sets a specific Cursor for a given device when it gets inside surface. Use cursorNewFromName or cursorNewFromTexture to create the cursor. To make the cursor invisible, use GDK_BLANK_CURSOR. Passing Nothing for the cursor argument to surfaceSetCursor means that surface will use the cursor of its parent surface. Most surfaces should use this default.

setInputRegion

surfaceSetInputRegion

Arguments

:: (HasCallStack, MonadIO m, IsSurface a)

=> a

surface: a Surface

-> Region

region: region of surface to be reactive

-> m ()

Apply the region to the surface for the purpose of event handling. Mouse events which happen while the pointer position corresponds to an unset bit in the mask will be passed on the surface below surface.

An input region is typically used with RGBA surfaces. The alpha channel of the surface defines which pixels are invisible and allows for nicely antialiased borders, and the input region controls where the surface is “clickable”.

Use displaySupportsInputShapes to find out if a particular backend supports input regions.

setOpaqueRegion

surfaceSetOpaqueRegion

Arguments

:: (HasCallStack, MonadIO m, IsSurface a)

=> a

surface: a top-level or non-native Surface

-> Maybe Region

region: a region, or Nothing

-> m ()

For optimisation purposes, compositing window managers may like to not draw obscured regions of surfaces, or turn off blending during for these regions. With RGB windows with no transparency, this is just the shape of the window, but with ARGB32 windows, the compositor does not know what regions of the window are transparent or not.

This function only works for toplevel surfaces.

GTK will update this property automatically if the surface background is opaque, as we know where the opaque regions are. If your surface background is not opaque, please update this property in your GtkWidgetClass.css_changed() handler.

translateCoordinates

surfaceTranslateCoordinates

Arguments

:: (HasCallStack, MonadIO m, IsSurface a, IsSurface b)

=> a

from: the origin surface

-> b

to: the target surface

-> Double

x: coordinates to translate

-> Double

y: coordinates to translate

-> m Bool

Returns: True if the coordinates were successfully translated

Translates the given coordinates from being relative to the from surface to being relative to the to surface.

Note that this only works if to and from are popups or transient-for to the same toplevel (directly or indirectly).

Properties

cursor

The mouse pointer for a Surface. See surfaceSetCursor and surfaceGetCursor for details.

clearSurfaceCursor :: (MonadIO m, IsSurface o) => o -> m ()

Set the value of the “cursor” property to Nothing. When overloading is enabled, this is equivalent to

clear #cursor

constructSurfaceCursor :: (IsSurface o, MonadIO m, IsCursor a) => a -> m (GValueConstruct o)

Construct a GValueConstruct with valid value for the “cursor” property. This is rarely needed directly, but it is used by new.

getSurfaceCursor :: (MonadIO m, IsSurface o) => o -> m (Maybe Cursor)

Get the value of the “cursor” property. When overloading is enabled, this is equivalent to

get surface #cursor

setSurfaceCursor :: (MonadIO m, IsSurface o, IsCursor a) => o -> a -> m ()

Set the value of the “cursor” property. When overloading is enabled, this is equivalent to

set surface [ #cursor := value ]

display

The Display connection of the surface. See surfaceGetDisplay for details.

constructSurfaceDisplay :: (IsSurface o, MonadIO m, IsDisplay a) => a -> m (GValueConstruct o)

Construct a GValueConstruct with valid value for the “display” property. This is rarely needed directly, but it is used by new.

getSurfaceDisplay :: (MonadIO m, IsSurface o) => o -> m Display

Get the value of the “display” property. When overloading is enabled, this is equivalent to

get surface #display

frameClock

No description available in the introspection data.

constructSurfaceFrameClock :: (IsSurface o, MonadIO m, IsFrameClock a) => a -> m (GValueConstruct o)

Construct a GValueConstruct with valid value for the “frame-clock” property. This is rarely needed directly, but it is used by new.

getSurfaceFrameClock :: (MonadIO m, IsSurface o) => o -> m FrameClock

Get the value of the “frame-clock” property. When overloading is enabled, this is equivalent to

get surface #frameClock

height

No description available in the introspection data.

getSurfaceHeight :: (MonadIO m, IsSurface o) => o -> m Int32

Get the value of the “height” property. When overloading is enabled, this is equivalent to

get surface #height

mapped

No description available in the introspection data.

getSurfaceMapped :: (MonadIO m, IsSurface o) => o -> m Bool

Get the value of the “mapped” property. When overloading is enabled, this is equivalent to

get surface #mapped

scaleFactor

No description available in the introspection data.

getSurfaceScaleFactor :: (MonadIO m, IsSurface o) => o -> m Int32

Get the value of the “scale-factor” property. When overloading is enabled, this is equivalent to

get surface #scaleFactor

width

No description available in the introspection data.

getSurfaceWidth :: (MonadIO m, IsSurface o) => o -> m Int32

Get the value of the “width” property. When overloading is enabled, this is equivalent to

get surface #width

Signals

enterMonitor

type C_SurfaceEnterMonitorCallback = Ptr () -> Ptr Monitor -> Ptr () -> IO ()

Type for the callback on the (unwrapped) C side.

type SurfaceEnterMonitorCallback

Arguments

 = Monitor

monitor: the monitor

-> IO ()

Emitted when surface starts being present on the monitor.

afterSurfaceEnterMonitor :: (IsSurface a, MonadIO m) => a -> SurfaceEnterMonitorCallback -> m SignalHandlerId

Connect a signal handler for the enterMonitor signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after surface #enterMonitor callback

genClosure_SurfaceEnterMonitor :: MonadIO m => SurfaceEnterMonitorCallback -> m (GClosure C_SurfaceEnterMonitorCallback)

Wrap the callback into a GClosure.

mk_SurfaceEnterMonitorCallback :: C_SurfaceEnterMonitorCallback -> IO (FunPtr C_SurfaceEnterMonitorCallback)

Generate a function pointer callable from C code, from a C_SurfaceEnterMonitorCallback.

noSurfaceEnterMonitorCallback :: Maybe SurfaceEnterMonitorCallback

A convenience synonym for Nothing :: Maybe SurfaceEnterMonitorCallback.

onSurfaceEnterMonitor :: (IsSurface a, MonadIO m) => a -> SurfaceEnterMonitorCallback -> m SignalHandlerId

Connect a signal handler for the enterMonitor signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on surface #enterMonitor callback

wrap_SurfaceEnterMonitorCallback :: SurfaceEnterMonitorCallback -> C_SurfaceEnterMonitorCallback

Wrap a SurfaceEnterMonitorCallback into a C_SurfaceEnterMonitorCallback.

event

type C_SurfaceEventCallback = Ptr () -> Ptr Event -> Ptr () -> IO CInt

Type for the callback on the (unwrapped) C side.

type SurfaceEventCallback

Arguments

 = Event

event: an input event

-> IO Bool

Returns: True to indicate that the event has been handled

Emitted when GDK receives an input event for surface.

afterSurfaceEvent :: (IsSurface a, MonadIO m) => a -> SurfaceEventCallback -> m SignalHandlerId

Connect a signal handler for the event signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after surface #event callback

genClosure_SurfaceEvent :: MonadIO m => SurfaceEventCallback -> m (GClosure C_SurfaceEventCallback)

Wrap the callback into a GClosure.

mk_SurfaceEventCallback :: C_SurfaceEventCallback -> IO (FunPtr C_SurfaceEventCallback)

Generate a function pointer callable from C code, from a C_SurfaceEventCallback.

noSurfaceEventCallback :: Maybe SurfaceEventCallback

A convenience synonym for Nothing :: Maybe SurfaceEventCallback.

onSurfaceEvent :: (IsSurface a, MonadIO m) => a -> SurfaceEventCallback -> m SignalHandlerId

Connect a signal handler for the event signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on surface #event callback

wrap_SurfaceEventCallback :: SurfaceEventCallback -> C_SurfaceEventCallback

Wrap a SurfaceEventCallback into a C_SurfaceEventCallback.

layout

type C_SurfaceLayoutCallback = Ptr () -> Int32 -> Int32 -> Ptr () -> IO ()

Type for the callback on the (unwrapped) C side.

type SurfaceLayoutCallback

Arguments

 = Int32

width: the current width

-> Int32

height: the current height

-> IO ()

Emitted when the size of surface is changed, or when relayout should be performed.

Surface size is reported in ”application pixels”, not ”device pixels” (see surfaceGetScaleFactor).

afterSurfaceLayout :: (IsSurface a, MonadIO m) => a -> SurfaceLayoutCallback -> m SignalHandlerId

Connect a signal handler for the layout signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after surface #layout callback

genClosure_SurfaceLayout :: MonadIO m => SurfaceLayoutCallback -> m (GClosure C_SurfaceLayoutCallback)

Wrap the callback into a GClosure.

mk_SurfaceLayoutCallback :: C_SurfaceLayoutCallback -> IO (FunPtr C_SurfaceLayoutCallback)

Generate a function pointer callable from C code, from a C_SurfaceLayoutCallback.

noSurfaceLayoutCallback :: Maybe SurfaceLayoutCallback

A convenience synonym for Nothing :: Maybe SurfaceLayoutCallback.

onSurfaceLayout :: (IsSurface a, MonadIO m) => a -> SurfaceLayoutCallback -> m SignalHandlerId

Connect a signal handler for the layout signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on surface #layout callback

wrap_SurfaceLayoutCallback :: SurfaceLayoutCallback -> C_SurfaceLayoutCallback

Wrap a SurfaceLayoutCallback into a C_SurfaceLayoutCallback.

leaveMonitor

type C_SurfaceLeaveMonitorCallback = Ptr () -> Ptr Monitor -> Ptr () -> IO ()

Type for the callback on the (unwrapped) C side.

type SurfaceLeaveMonitorCallback

Arguments

 = Monitor

monitor: the monitor

-> IO ()

Emitted when surface stops being present on the monitor.

afterSurfaceLeaveMonitor :: (IsSurface a, MonadIO m) => a -> SurfaceLeaveMonitorCallback -> m SignalHandlerId

Connect a signal handler for the leaveMonitor signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after surface #leaveMonitor callback

genClosure_SurfaceLeaveMonitor :: MonadIO m => SurfaceLeaveMonitorCallback -> m (GClosure C_SurfaceLeaveMonitorCallback)

Wrap the callback into a GClosure.

mk_SurfaceLeaveMonitorCallback :: C_SurfaceLeaveMonitorCallback -> IO (FunPtr C_SurfaceLeaveMonitorCallback)

Generate a function pointer callable from C code, from a C_SurfaceLeaveMonitorCallback.

noSurfaceLeaveMonitorCallback :: Maybe SurfaceLeaveMonitorCallback

A convenience synonym for Nothing :: Maybe SurfaceLeaveMonitorCallback.

onSurfaceLeaveMonitor :: (IsSurface a, MonadIO m) => a -> SurfaceLeaveMonitorCallback -> m SignalHandlerId

Connect a signal handler for the leaveMonitor signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on surface #leaveMonitor callback

wrap_SurfaceLeaveMonitorCallback :: SurfaceLeaveMonitorCallback -> C_SurfaceLeaveMonitorCallback

Wrap a SurfaceLeaveMonitorCallback into a C_SurfaceLeaveMonitorCallback.

render

type C_SurfaceRenderCallback = Ptr () -> Ptr Region -> Ptr () -> IO CInt

Type for the callback on the (unwrapped) C side.

type SurfaceRenderCallback

Arguments

 = Region

region: the region that needs to be redrawn

-> IO Bool

Returns: True to indicate that the signal has been handled

Emitted when part of the surface needs to be redrawn.

afterSurfaceRender :: (IsSurface a, MonadIO m) => a -> SurfaceRenderCallback -> m SignalHandlerId

Connect a signal handler for the render signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after surface #render callback

genClosure_SurfaceRender :: MonadIO m => SurfaceRenderCallback -> m (GClosure C_SurfaceRenderCallback)

Wrap the callback into a GClosure.

mk_SurfaceRenderCallback :: C_SurfaceRenderCallback -> IO (FunPtr C_SurfaceRenderCallback)

Generate a function pointer callable from C code, from a C_SurfaceRenderCallback.

noSurfaceRenderCallback :: Maybe SurfaceRenderCallback

A convenience synonym for Nothing :: Maybe SurfaceRenderCallback.

onSurfaceRender :: (IsSurface a, MonadIO m) => a -> SurfaceRenderCallback -> m SignalHandlerId

Connect a signal handler for the render signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on surface #render callback

wrap_SurfaceRenderCallback :: SurfaceRenderCallback -> C_SurfaceRenderCallback

Wrap a SurfaceRenderCallback into a C_SurfaceRenderCallback.