Struct ccthw::graphics::vulkan_api::RenderDevice

pub struct RenderDevice { /* private fields */ }

A combination of the VulkanInstance, LogicalDevice, and queues required by this application.

Implementations

impl RenderDevice

pub unsafe fn new( instance: VulkanInstance, features: PhysicalDeviceFeatures, surface: SurfaceKHR ) -> Result<Self, GraphicsError>

Create a new render device.

Params

• instance - the VulkanInstance used to create all application resources. The RenderDevice takes ownership of the vulkan instance so it can be destroyed in the correct order.
• features - the physical device features required by this application.
• surface - the surface this application will use for swapchain presentation. Typically provided by the windowing system.

Safety

Unsafe because the application must destroy the render device before exit. The application must also destroy all resources created by the logical device before destroying the render device.

pub fn memory(&self) -> MutexGuard<'_, MemoryAllocator>

Borrow the device memory allocator.

pub fn set_debug_name( &self, handle: impl Handle, object_type: ObjectType, name: impl Into<String> )

Set the name that shows up in Vulkan debug logs for a given resource.

Params

• handle - a Vulkan resource represented by the Ash library
• object_type - the Vulkan object type
• name - a human-readable name for the object. This will show up in debug logs if the object is referenced.

pub fn presentation_queue(&self) -> &Queue

The queue this application uses for graphics operations.

pub fn graphics_queue(&self) -> &Queue

The queue this application uses for graphics operations.

pub fn entry(&self) -> &Entry

The Ash entry used by this RenderDevice.

pub fn ash(&self) -> &Instance

The Ash instance used by this RenderDevice.

pub unsafe fn device(&self) -> &Device

The Ash logical device used to interface with the underlying Vulkan hardware device.

Safety

The caller must not keep copies of the device handle after the render device is dropped.

pub unsafe fn surface(&self) -> &SurfaceKHR

The KHR surface provided by the window system for rendering.

Safety

The caller must not keep copies of the device handle after the render device is dropped.

pub fn get_surface_formats( &self ) -> Result<Vec<SurfaceFormatKHR>, GraphicsError>

Get all of the surface formats supported by this device.

pub fn get_present_modes(&self) -> Result<Vec<PresentModeKHR>, GraphicsError>

Get all of the presentation modes supported by this device.

pub fn get_surface_capabilities( &self ) -> Result<SurfaceCapabilitiesKHR, GraphicsError>

Get the surface capabilities for this device.

Trait Implementations

impl Debug for RenderDevice

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Display for RenderDevice

fn fmt(&self, formatter: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Drop for RenderDevice

fn drop(&mut self)

Executes the destructor for this type.