Surface

A gdk.surface.Surface is a rectangular region on the screen.

It’s a low-level object, used to implement high-level objects such as GtkWindow.

The surfaces you see in practice are either gdk.toplevel.Toplevel or gdk.popup.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.

class Surface : ObjectG {

static gdk.surface.Surface newPopup(gdk.surface.Surface parent, bool autohide);

static gdk.surface.Surface newToplevel(gdk.display.Display display);

void beep();

gdk.cairo_context.CairoContext createCairoContext();

gdk.glcontext.GLContext createGlContext();

cairo.surface.Surface createSimilarSurface(cairo.types.Content content, int width, int height);

gdk.vulkan_context.VulkanContext createVulkanContext();

void destroy();

gdk.cursor.Cursor getCursor();

gdk.cursor.Cursor getDeviceCursor(gdk.device.Device device);

bool getDevicePosition(gdk.device.Device device, double x, double y, gdk.types.ModifierType mask);

gdk.display.Display getDisplay();

gdk.frame_clock.FrameClock getFrameClock();

int getHeight();

bool getMapped();

double getScale();

int getScaleFactor();

int getWidth();

void hide();

bool isDestroyed();

void queueRender();

void requestLayout();

void setCursor(gdk.cursor.Cursor cursor);

void setDeviceCursor(gdk.device.Device device, gdk.cursor.Cursor cursor);

void setInputRegion(cairo.region.Region region);

void setOpaqueRegion(cairo.region.Region region);

bool translateCoordinates(gdk.surface.Surface to, double x, double y);

ulong connectEnterMonitor(T callback, Flag!"After" after);

ulong connectEvent(T callback, Flag!"After" after);

ulong connectLayout(T callback, Flag!"After" after);

ulong connectLeaveMonitor(T callback, Flag!"After" after);

ulong connectRender(T callback, Flag!"After" after);

}

Members

Functions

beep void beep(): Emits a short beep associated to surface.
connectEnterMonitor ulong connectEnterMonitor(T callback, Flag!"After" after): Connect to EnterMonitor signal.
connectEvent ulong connectEvent(T callback, Flag!"After" after): Connect to Event signal.
connectLayout ulong connectLayout(T callback, Flag!"After" after): Connect to Layout signal.
connectLeaveMonitor ulong connectLeaveMonitor(T callback, Flag!"After" after): Connect to LeaveMonitor signal.
connectRender ulong connectRender(T callback, Flag!"After" after): Connect to Render signal.
createCairoContext gdk.cairo_context.CairoContext createCairoContext(): Creates a new gdk.cairo_context.CairoContext for rendering on surface.
createGlContext gdk.glcontext.GLContext createGlContext(): Creates a new gdk.glcontext.GLContext for the gdk.surface.Surface.
createSimilarSurface cairo.surface.Surface createSimilarSurface(cairo.types.Content content, int width, int height): Create a new Cairo surface that is as compatible as possible with the given surface.
createVulkanContext gdk.vulkan_context.VulkanContext createVulkanContext(): Sets an error and returns null.
destroy void destroy(): Destroys the window system resources associated with surface and decrements surface's reference count.
getCursor gdk.cursor.Cursor getCursor(): Retrieves a gdk.cursor.Cursor pointer for the cursor currently set on the gdk.surface.Surface.
getDeviceCursor gdk.cursor.Cursor getDeviceCursor(gdk.device.Device device): Retrieves a gdk.cursor.Cursor pointer for the device currently set on the specified gdk.surface.Surface.
getDevicePosition bool getDevicePosition(gdk.device.Device device, double x, double y, gdk.types.ModifierType mask): Obtains the current device position and modifier state.
getDisplay gdk.display.Display getDisplay(): Gets the gdk.display.Display associated with a gdk.surface.Surface.
getFrameClock gdk.frame_clock.FrameClock getFrameClock(): Gets the frame clock for the surface.
getHeight int getHeight(): Returns the height of the given surface.
getMapped bool getMapped(): Checks whether the surface has been mapped.
getScale double getScale(): Returns the internal scale that maps from surface coordinates to the actual device pixels.
getScaleFactor int getScaleFactor(): Returns the internal scale factor that maps from surface coordinates to the actual device pixels.
getWidth int getWidth(): Returns the width of the given surface.
hide void hide(): Hide the surface.
isDestroyed bool isDestroyed(): Check to see if a surface is destroyed.
queueRender void queueRender(): Forces a gdk.surface.Surface.render signal emission for surface to be scheduled.
requestLayout void requestLayout(): Request a layout phase from the surface's frame clock.
setCursor void setCursor(gdk.cursor.Cursor cursor): Sets the default mouse pointer for a gdk.surface.Surface.
setDeviceCursor void setDeviceCursor(gdk.device.Device device, gdk.cursor.Cursor cursor): Sets a specific gdk.cursor.Cursor for a given device when it gets inside surface.
setInputRegion void setInputRegion(cairo.region.Region region): Apply the region to the surface for the purpose of event handling.
setOpaqueRegion void setOpaqueRegion(cairo.region.Region region): Marks a region of the gdk.surface.Surface as opaque.
translateCoordinates bool translateCoordinates(gdk.surface.Surface to, double x, double y): Translates coordinates between two surfaces.

Static functions

newPopup gdk.surface.Surface newPopup(gdk.surface.Surface parent, bool autohide): Create a new popup surface.
newToplevel gdk.surface.Surface newToplevel(gdk.display.Display display): Creates a new toplevel surface.

Inherited Members

From ObjectG

setGObject void setGObject(void* cObj, Flag!"Take" take): Set the GObject of a D ObjectG wrapper.
cPtr void* cPtr(Flag!"Dup" dup): Get a pointer to the underlying C object.
ref_ void* ref_(void* gObj): Calls g_object_ref() on a GObject.
unref unref(void* gObj): Calls g_object_unref() on a GObject.
getType GType getType(): Get the GType of an object.
gType GType gType [@property getter]: GObject GType property.
self ObjectG self(): Convenience method to return this cast to a type. For use in D with statements.
getDObject T getDObject(void* cptr, Flag!"Take" take): Template to get the D object from a C GObject and cast it to the given D object type.
connectSignalClosure ulong connectSignalClosure(string signalDetail, DClosure closure, Flag!"After" after): Connect a D closure to an object signal.
setProperty void setProperty(string propertyName, T val): Template for setting a GObject property.
getProperty T getProperty(string propertyName): Template for getting a GObject property.
compatControl size_t compatControl(size_t what, void* data)
bindProperty gobject.binding.Binding bindProperty(string sourceProperty, gobject.object.ObjectG target, string targetProperty, gobject.types.BindingFlags flags): Creates a binding between source_property on source and target_property on target.
bindPropertyFull gobject.binding.Binding bindPropertyFull(string sourceProperty, gobject.object.ObjectG target, string targetProperty, gobject.types.BindingFlags flags, gobject.closure.Closure transformTo, gobject.closure.Closure transformFrom): Creates a binding between source_property on source and target_property on target, allowing you to set the transformation functions to be used by the binding.
forceFloating void forceFloating(): This function is intended for #GObject implementations to re-enforce a floating[floating-ref] object reference. Doing this is seldom required: all #GInitiallyUnowneds are created with a floating reference which usually just needs to be sunken by calling gobject.object.ObjectG.refSink.
freezeNotify void freezeNotify(): Increases the freeze count on object. If the freeze count is non-zero, the emission of "notify" signals on object is stopped. The signals are queued until the freeze count is decreased to zero. Duplicate notifications are squashed so that at most one #GObject::notify signal is emitted for each property modified while the object is frozen.
getData void* getData(string key): Gets a named field from the objects table of associations (see gobject.object.ObjectG.setData).
getProperty void getProperty(string propertyName, gobject.value.Value value): Gets a property of an object.
getQdata void* getQdata(glib.types.Quark quark): This function gets back user data pointers stored via gobject.object.ObjectG.setQdata.
getv void getv(string[] names, gobject.value.Value[] values): Gets n_properties properties for an object. Obtained properties will be set to values. All properties must be valid. Warnings will be emitted and undefined behaviour may result if invalid properties are passed in.
isFloating bool isFloating(): Checks whether object has a floating[floating-ref] reference.
notify void notify(string propertyName): Emits a "notify" signal for the property property_name on object.
notifyByPspec void notifyByPspec(gobject.param_spec.ParamSpec pspec): Emits a "notify" signal for the property specified by pspec on object.
refSink gobject.object.ObjectG refSink(): Increase the reference count of object, and possibly remove the floating[floating-ref] reference, if object has a floating reference.
runDispose void runDispose(): Releases all references to other objects. This can be used to break reference cycles.
setData void setData(string key, void* data): Each object carries around a table of associations from strings to pointers. This function lets you set an association.
setProperty void setProperty(string propertyName, gobject.value.Value value): Sets a property on an object.
stealData void* stealData(string key): Remove a specified datum from the object's data associations, without invoking the association's destroy handler.
stealQdata void* stealQdata(glib.types.Quark quark): This function gets back user data pointers stored via gobject.object.ObjectG.setQdata and removes the data from object without invoking its destroy() function (if any was set). Usually, calling this function is only required to update user data pointers with a destroy notifier, for example:
thawNotify void thawNotify(): Reverts the effect of a previous call to gobject.object.ObjectG.freezeNotify. The freeze count is decreased on object and when it reaches zero, queued "notify" signals are emitted.
watchClosure void watchClosure(gobject.closure.Closure closure): This function essentially limits the life time of the closure to the life time of the object. That is, when the object is finalized, the closure is invalidated by calling gobject.closure.Closure.invalidate on it, in order to prevent invocations of the closure with a finalized (nonexisting) object. Also, gobject.object.ObjectG.ref_ and gobject.object.ObjectG.unref are added as marshal guards to the closure, to ensure that an extra reference count is held on object during invocation of the closure. Usually, this function will be called on closures that use this object as closure data.
connectNotify ulong connectNotify(string detail, T callback, Flag!"After" after): Connect to Notify signal.

gdk surface classes

Surface