ImageAcquisition

Result of Image acquisition from a Swapchain.

struct ImageAcquisition {

static ImageAcquisition makeOk(uint index);

static ImageAcquisition makeSuboptimal(uint index);

static ImageAcquisition makeOutOfDate();

static ImageAcquisition makeNotReady();

State state [@property getter];

uint index [@property getter];

bool ok [@property getter];

bool suboptimal [@property getter];

bool outOfDate [@property getter];

bool notReady [@property getter];

bool hasIndex [@property getter];

bool swapchainNeedsRebuild [@property getter];

}

Members

Enums

State enum State: An Image Acquisition can have one of the 4 following states.

Properties

hasIndex bool hasIndex [@property getter]: Whether an image could be acquired
index uint index [@property getter]: Get the index of the acquired image
notReady bool notReady [@property getter]: Whether the acquisition is in not-ready state
ok bool ok [@property getter]: Whether the acquisition is in OK state
outOfDate bool outOfDate [@property getter]: Whether the acquisition is in out-of-date state
state State state [@property getter]: Get the state of the acquisition
suboptimal bool suboptimal [@property getter]: Whether the acquisition is in suboptimal state
swapchainNeedsRebuild bool swapchainNeedsRebuild [@property getter]: Whether the Swapchain should be reconstructed

Static functions

makeNotReady ImageAcquisition makeNotReady(): Make an ImageAcquisition in notReady state.
makeOk ImageAcquisition makeOk(uint index): Make an ImageAcquisition in OK state with the given image index.
makeOutOfDate ImageAcquisition makeOutOfDate(): Make an ImageAcquisition in out-of-date state.
makeSuboptimal ImageAcquisition makeSuboptimal(uint index): Make an ImageAcquisition in Suboptimal state with the given image index.

See Also

Swapchain.acquireNextImage

Meta

Source

See Implementation

gfx graal presentation enums

interfaces

structs