Swapchain

Handle to a swapchain engine

interface Swapchain : IAtomicRefCounted {

interface Device via import gfx.graal.device : Device;;

import core.time : dur;;

Device device [@property getter];

Surface surface [@property getter];

Format format [@property getter];

ImageBase[] images [@property getter];

ImageAcquisition acquireNextImage(Semaphore semaphore, Duration timeout);

}

Members

Functions

acquireNextImage ImageAcquisition acquireNextImage(Semaphore semaphore, Duration timeout): Acquire the next image in the swapchain. This function may block until the next image is available.

Properties

device Device device [@property getter]: Get the parent device
format Format format [@property getter]: The image format of this swapchain
images ImageBase[] images [@property getter]: Get the list of images owned by this swapchain. The index of each image is meaningful and is often used to reference the image (such as the index returned by acquireNextImage)
surface Surface surface [@property getter]: Get the Surface that this swapchain is bound to.

Inherited Members

From IAtomicRefCounted

refCount size_t refCount [@property getter]
refCountShared size_t refCountShared [@property getter]: Atomically loads the number of active references.
retain void retain()
retainShared void retainShared(): Atomically increment the reference count.
release bool release(Flag!"disposeOnZero" disposeOnZero)
releaseShared bool releaseShared(Flag!"disposeOnZero" disposeOnZero): Atomically decrement the reference count. If refCount reaches zero, and disposeOnZero is set, the object is locked with its own mutex, and dispose is called. In most cases, the calling code should set disposeOnZero, unless it is intended to release the object to give it away. (such as at the end of a builder function)
rcLock bool rcLock()
rcLockShared bool rcLockShared(): Returns whether the refCount >= 1. This increases the refCount by 1. rcLock should be used to keep weak reference and ensures that the resource is not disposed. The operation is atomic.
dispose void dispose(): Dispose the underlying resource

Meta

Source

See Implementation

gfx graal presentation enums

interfaces

structs