[−][src]Module gfx_hal::window

Windowing system interoperability

Screen presentation (fullscreen or window) of images requires two objects:

Surface is the host abstraction of the native screen
Swapchain is the device abstraction for a surface, containing multiple presentable images

The most interesting part of a swapchain are the contained presentable images/backbuffers. Presentable images are specialized images, which can be presented on the screen. They are 2D color images with optionally associated depth-stencil images.

The common steps for presentation of a frame are acquisition and presentation:


let acquisition_semaphore = device.create_semaphore().unwrap();
let render_semaphore = device.create_semaphore().unwrap();

let (frame, suboptimal) = swapchain.acquire_image(!0, Some(&acquisition_semaphore), None).unwrap();
// render the scene..
// `render_semaphore` will be signalled once rendering has been finished
swapchain.present(&mut present_queue, 0, &[render_semaphore]);

Queues need to synchronize with the presentation engine, usually done via signalling a semaphore once a frame is available for rendering and waiting on a separate semaphore until scene rendering has finished.

Recreation

DOC TODO

Structs

CompositeAlphaMode	Specifies how the alpha channel of the images should be handled during compositing.
Extent2D	An extent describes the size of a rectangle, such as a window or texture. It is not used for referring to a sub-rectangle; for that see `command::Rect`.
PresentMode	Specifies the mode regulating how a swapchain presents frames.
Suboptimal	Marker value returned if the swapchain no longer matches the surface properties exactly, but can still be used to present to the surface successfully.
SurfaceCapabilities	Describes information about what a `Surface`'s properties are. Fetch this with [Surface::capabilities].
SwapchainConfig	Contains all the data necessary to create a new `Swapchain`: color, depth, and number of images.

Enums

AcquireError	Error on acquiring the next image from a swapchain.
CreationError	Error occurred during swapchain creation.
InitError	Error occurred during surface creation.
PresentError	Error on acquiring the next image from a swapchain.

Constants

DEFAULT_IMAGE_COUNT	Default image count for the swapchain.
DEFAULT_USAGE	Default image usage for the swapchain.

Traits

PresentationSurface	A surface trait that exposes the ability to present images on the associtated swap chain.
Surface	A `Surface` abstracts the surface of a native window.
Swapchain	The `Swapchain` is the backend representation of the surface. It consists of multiple buffers, which will be presented on the surface.

Type Definitions

SwapImageIndex

Index of an image in the swapchain.