Struct rafx_api::extra::swapchain_helper::RafxPresentableFrame

pub struct RafxPresentableFrame { /* private fields */ }

Represents an acquired image from a swapchain. It can move between threads and be sumitted by any thread. The swapchain helper will not provide another image until this one is presented.

To ease error handling, the swapchain may be submitted with an error. This error will be returned on the next attempt to acquire a swapchain image (i.e. the main thread).

Implementations

impl RafxPresentableFrame

pub fn rotating_frame_index(&self) -> usize

An index that starts at 0 on the first present and increments every frame, wrapping back to 0 after each swapchain image has been presented once. (See image_count on RafxSwapchainHelper). WARNING: This is not always the returned swapchain image. Swapchain images may be acquired in any order.

pub fn incrementing_frame_index(&self) -> usize

pub fn swapchain_texture(&self) -> &RafxTexture

Returns the acquired swapchain image

pub fn swapchain(&self) -> &Arc<Mutex<RafxSwapchain>>

Returns the swapchain. The swapchain helper code generally assumes ownership/management of the swapchain. Messing with it may invalidate assumptions in the swapchain helper code, so mutating operations on it are not recommended

pub fn present( self, queue: &RafxQueue, command_buffers: &[&RafxCommandBuffer] ) -> RafxResult<RafxPresentSuccessResult>

Submits the given command buffers and schedules the swapchain image to be presented after their completion

pub fn present_with_error(self, queue: &RafxQueue, error: RafxError)

Presents the current swapchain image and returns the given error during the next image acquisition attempt

pub fn do_present( &mut self, queue: &RafxQueue, command_buffers: &[&RafxCommandBuffer] ) -> RafxResult<RafxPresentSuccessResult>

Trait Implementations

impl Drop for RafxPresentableFrame

fn drop(&mut self)

Executes the destructor for this type.