Enum rafx_api::RafxApi

pub enum RafxApi {
    Empty(RafxApiEmpty),
}

Primary entry point to using the API. Use the new_* functions to initialize the desired backend.

This API object must persist for the lifetime of all objects created through it. This is verified at runtime when the API object is destroyed - either explicitly via destroy() or by dropping the object.

Once the API object is created, use device_context() to obtain a cloneable handle to the device. The RafxDeviceContext is the primary way of interacting with the API once it has been initialized. These contexts and all other objects created through them must be dropped before dropping RafxApi or calling RafxApi::destroy().

Variants

Empty(RafxApiEmpty)

Implementations

impl RafxApi

pub unsafe fn new( _display: &dyn HasRawDisplayHandle, _window: &dyn HasRawWindowHandle, _api_def: &RafxApiDef ) -> RafxResult<Self>

Create a device using the “default” backend for the platform.

Safety

GPU programming is fundamentally unsafe, so all rafx APIs that interact with the GPU should be considered unsafe. However, rafx APIs are only gated by unsafe if they can cause undefined behavior on the CPU for reasons other than interacting with the GPU.

pub fn device_context(&self) -> RafxDeviceContext

Create a cloneable handle to the device. Most of the interaction with the graphics backend is done through this handle.

The RafxDeviceContext does not need to be kept in scope. As long as the RafxApi remains in scope, dropping the device context does not do anything, and it can be obtained again by calling this function.

This context is intended to be safely shared across threads. This function is thread-safe, and generally all APIs on the device context itself are thread-safe.

pub fn destroy(&mut self) -> RafxResult<()>

Destroys the graphics API instance. Any RafxDeviceContext created through this API, and any object created through those device contexts, must be dropped before calling destroy()

destroy() is automatically called if RafxApi is dropped and it has not yet been called, so it is not necessary to call this function explicitly.

pub fn empty_api(&self) -> Option<&RafxApiEmpty>

Get the underlying metal API object. This provides access to any internally created metal objects.