CairoContextProtocol

public protocol CairoContextProtocol : DrawContextProtocol

The CairoContextProtocol protocol exposes the methods and properties of an underlying GdkCairoContext 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 CairoContext. Alternatively, use CairoContextRef as a lighweight, unowned reference if you already have an instance you just want to use.

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

GdkCairoContexts are created for a surface using [methodGdk.Surface.create_cairo_context], and the context can then be used to draw on that surface.

  • ptr

    Untyped pointer to the underlying GdkCairoContext instance.

    Declaration

    Swift

    var ptr: UnsafeMutableRawPointer! { get }
  • cairo_context_ptr Default implementation

    Typed pointer to the underlying GdkCairoContext instance.

    Default Implementation

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

    Declaration

    Swift

    var cairo_context_ptr: UnsafeMutablePointer<GdkCairoContext>! { get }
  • Required Initialiser for types conforming to CairoContextProtocol

    Declaration

    Swift

    init(raw: UnsafeMutableRawPointer)

CairoContext Class

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

    Declaration

    Swift

    @discardableResult
    @inlinable
    func bind<Q, T>(property source_property: CairoContextPropertyName, 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

  • get(property:) Extension method

    Get the value of a CairoContext property

    Declaration

    Swift

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

    Parameters

    property

    the property to get the value for

    Return Value

    the value of the named property

  • set(property:value:) Extension method

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

    Declaration

    Swift

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

    Parameters

    property

    the property to get the value for

    Return Value

    the value of the named property

CairoContext Class: CairoContextProtocol extension (methods and fields)

  • cairoCreate() Extension method

    Retrieves a Cairo context to be used to draw on the GdkSurface of context.

    A call to [methodGdk.DrawContext.begin_frame] with this context must have been done or this function will return nil.

    The returned context is guaranteed to be valid until [methodGdk.DrawContext.end_frame] is called.

    Declaration

    Swift

    @inlinable
    func cairoCreate() -> Cairo.ContextRef!