DrawingContextProtocol

public protocol DrawingContextProtocol : ObjectProtocol

The DrawingContextProtocol protocol exposes the methods and properties of an underlying GdkDrawingContext instance. The default implementation of these can be found in the protocol extension below. For a concrete class that implements these methods and properties, see DrawingContext. Alternatively, use DrawingContextRef as a lighweight, unowned reference if you already have an instance you just want to use.

GdkDrawingContext is an object that represents the current drawing state of a GdkWindow.

It’s possible to use a GdkDrawingContext to draw on a GdkWindow via rendering API like Cairo or OpenGL.

A GdkDrawingContext can only be created by calling gdk_window_begin_draw_frame() and will be valid until a call to gdk_window_end_draw_frame().

GdkDrawingContext is available since GDK 3.22

Show on GitHub
  • ptr

    Untyped pointer to the underlying GdkDrawingContext instance.

    Declaration

    Swift

    var ptr: UnsafeMutableRawPointer! { get }
    Show on GitHub
  • drawing_context_ptr Default implementation

    Typed pointer to the underlying GdkDrawingContext instance.

    Default Implementation

    Return the stored, untyped pointer as a typed pointer to the GdkDrawingContext instance.

    Declaration

    Swift

    var drawing_context_ptr: UnsafeMutablePointer<GdkDrawingContext>! { get }
    Show on GitHub

  • Required Initialiser for types conforming to DrawingContextProtocol

    Declaration

    Swift

    init(raw: UnsafeMutableRawPointer)
    Show on GitHub

DrawingContext Class

  • Bind a DrawingContextPropertyName source property to a given target object.

    Declaration

    Swift

    @discardableResult
@inlinable
func bind<Q, T>(property source_property: DrawingContextPropertyName, to target: T, _ target_property: Q, flags f: BindingFlags = .default, transformFrom transform_from: @escaping GLibObject.ValueTransformer = { $0.transform(destValue: $1) }, transformTo transform_to: @escaping GLibObject.ValueTransformer = { $0.transform(destValue: $1) }) -> BindingRef! where Q : PropertyNameProtocol, T : ObjectProtocol

    Parameters

    source_property

    the source property to bind
    target

    the target object to bind to
    target_property

    the target property to bind to
    flags

    the flags to pass to the Binding
    transform_from

    ValueTransformer to use for forward transformation
    transform_to

    ValueTransformer to use for backwards transformation

    Return Value

    binding reference or nil in case of an error

    Show on GitHub
  • get(property:) Extension method

    Get the value of a DrawingContext property

    Declaration

    Swift

    @inlinable
func get(property: DrawingContextPropertyName) -> GLibObject.Value

    Parameters

    property

    the property to get the value for

    Return Value

    the value of the named property

    Show on GitHub
  • set(property:value:) Extension method

    Set the value of a DrawingContext property. Note that this will only have an effect on properties that are writable and not construct-only!

    Declaration

    Swift

    @inlinable
func set(property: DrawingContextPropertyName, value v: GLibObject.Value)

    Parameters

    property

    the property to get the value for

    Return Value

    the value of the named property

    Show on GitHub

DrawingContext Class: DrawingContextProtocol extension (methods and fields)

  • getCairoContext() Extension method

    Retrieves a Cairo context to be used to draw on the GdkWindow that created the GdkDrawingContext.

    The returned context is guaranteed to be valid as long as the GdkDrawingContext is valid, that is between a call to gdk_window_begin_draw_frame() and gdk_window_end_draw_frame().

    Declaration

    Swift

    @inlinable
func getCairoContext() -> Cairo.ContextRef!
    Show on GitHub
  • getClip() Extension method

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

    Declaration

    Swift

    @inlinable
func getClip() -> Cairo.RegionRef!
    Show on GitHub
  • getWindow() Extension method

    Retrieves the window that created the drawing context.

    Declaration

    Swift

    @inlinable
func getWindow() -> WindowRef!
    Show on GitHub
  • cairoContext Extension method

    Retrieves a Cairo context to be used to draw on the GdkWindow that created the GdkDrawingContext.

    The returned context is guaranteed to be valid as long as the GdkDrawingContext is valid, that is between a call to gdk_window_begin_draw_frame() and gdk_window_end_draw_frame().

    Declaration

    Swift

    @inlinable
var cairoContext: Cairo.ContextRef! { get }
    Show on GitHub
  • clip Extension method

    The clip region applied to the drawing context.

    Declaration

    Swift

    @inlinable
var clip: Cairo.RegionRef! { get }
    Show on GitHub
  • isValid Extension method

    Checks whether the given GdkDrawingContext is valid.

    Declaration

    Swift

    @inlinable
var isValid: Bool { get }
    Show on GitHub
  • window Extension method

    The GdkWindow that created the drawing context.

    Declaration

    Swift

    @inlinable
var window: WindowRef! { get }
    Show on GitHub