VulkanContextProtocol

public protocol VulkanContextProtocol : InitableProtocol, DrawContextProtocol

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

GdkVulkanContext is an object representing the platform-specific Vulkan draw context.

GdkVulkanContexts are created for a surface using [methodGdk.Surface.create_vulkan_context], and the context will match the the characteristics of the surface.

Support for GdkVulkanContext is platform-specific and context creation can fail, returning nil context.

Show on GitHub
  • ptr

    Untyped pointer to the underlying GdkVulkanContext instance.

    Declaration

    Swift

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

    Typed pointer to the underlying GdkVulkanContext instance.

    Default Implementation

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

    Declaration

    Swift

    var vulkan_context_ptr: UnsafeMutablePointer<GdkVulkanContext>! { get }
    Show on GitHub

  • Required Initialiser for types conforming to VulkanContextProtocol

    Declaration

    Swift

    init(raw: UnsafeMutableRawPointer)
    Show on GitHub

VulkanContext Class

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

    Declaration

    Swift

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

    Declaration

    Swift

    @inlinable
func get(property: VulkanContextPropertyName) -> 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 VulkanContext property. Note that this will only have an effect on properties that are writable and not construct-only!

    Declaration

    Swift

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

    Parameters

    property

    the property to get the value for

    Return Value

    the value of the named property

    Show on GitHub

VulkanContext signals

  • Connect a Swift signal handler to the given, typed VulkanContextSignalName signal

    Declaration

    Swift

    @discardableResult
@inlinable
func connect(signal s: VulkanContextSignalName, flags f: ConnectFlags = ConnectFlags(0), handler h: @escaping SignalHandler) -> Int

    Parameters

    signal

    The signal to connect
    flags

    The connection flags to use
    data

    A pointer to user data to provide to the callback
    destroyData

    A GClosureNotify C function to destroy the data pointed to by userData
    handler

    The Swift signal handler (function or callback) to invoke on the given signal

    Return Value

    The signal handler ID (always greater than 0 for successful connections)

    Show on GitHub

  • Connect a C signal handler to the given, typed VulkanContextSignalName signal

    Declaration

    Swift

    @discardableResult
@inlinable
func connect(signal s: VulkanContextSignalName, flags f: ConnectFlags = ConnectFlags(0), data userData: gpointer!, destroyData destructor: GClosureNotify? = nil, signalHandler h: @escaping GCallback) -> Int

    Parameters

    signal

    The signal to connect
    flags

    The connection flags to use
    data

    A pointer to user data to provide to the callback
    destroyData

    A GClosureNotify C function to destroy the data pointed to by userData
    signalHandler

    The C function to be called on the given signal

    Return Value

    The signal handler ID (always greater than 0 for successful connections)

    Show on GitHub

  • Emitted when the images managed by this context have changed.

    Usually this means that the swapchain had to be recreated, for example in response to a change of the surface size.

    Note

    This represents the underlying images-updated signal

    Declaration

    Swift

    @discardableResult
@inlinable
func onImagesUpdated(flags: ConnectFlags = ConnectFlags(0), handler: @escaping (_ unownedSelf: VulkanContextRef) -> Void) -> Int

    Parameters

    flags

    Flags
    unownedSelf

    Reference to instance of self
    handler

    The signal handler to call Run the given callback whenever the imagesUpdated signal is emitted
    Show on GitHub
  • imagesUpdatedSignal Extension method

    Typed images-updated signal for using the connect(signal:) methods

    Declaration

    Swift

    static var imagesUpdatedSignal: VulkanContextSignalName { get }
    Show on GitHub