Struct VulkanContext 

pub struct VulkanContext {
    pub pipeline_cache: Arc<VulkanPipelineCache>,
    pub desc_pool: Arc<DescriptorPool>,
    pub surface: Arc<VulkanSurface>,
    pub device: Arc<VulkanDevice>,
    pub cpu_renderer_threads: usize,
    /* private fields */
}

The Vulkan context has device, surface, swapchain, and command pools

Important

The VulkanContext would not going to own the surface. For example, if you are using GLFW, the surface is the GLFW window. If your surface is dropped earlier than then context, the context could not be dropped safely. You must make sure the context is dropped before the surface is dropped.

Fields

pipeline_cache: Arc<VulkanPipelineCache>

The pipeline cache here for a global usage

desc_pool: Arc<DescriptorPool>

The descriptor pool here is normally for a global usage

surface: Arc<VulkanSurface>

The surface in use

device: Arc<VulkanDevice>

The device in use

cpu_renderer_threads: usize

How many scenes could be rendered concurrently?

Implementations

impl VulkanContext

pub fn new( create_info: VulkanContextCreateInfo<'_, '_>, ) -> Result<Self, VulkanError>

Create a new VulkanContext

pub fn get_swapchain(&self) -> Arc<RwLock<VulkanSwapchain>>

Get the swapchain

pub fn get_swapchain_extent(&self) -> VkExtent2D

Get the current swapchain extent(the framebuffer size)

pub fn get_surface_size_( vkcore: &VkCore, device: &VulkanDevice, surface: &VulkanSurface, ) -> Result<VkExtent2D, VulkanError>

Get the surface size, a.k.a. the frame buffer size

pub fn get_surface_size(&self) -> Result<VkExtent2D, VulkanError>

Get the surface size, a.k.a. the frame buffer size

pub fn get_supported_number_of_cpu_renderer_threads(&self) -> usize

Get the number of CPU renderer threads that supports

pub fn create_pipeline_builder( &self, mesh: Arc<GenericMeshWithMaterial>, shaders: Arc<DrawShaders>, desc_props: Arc<DescriptorProps>, ) -> Result<PipelineBuilder, VulkanError>

Create a pipeline builder

pub fn recreate_swapchain( &self, width: u32, height: u32, present_interval: PresentInterval, is_vr: bool, ) -> Result<(), VulkanError>

Recreate the swapchain when users toggle the switch of vsync or the framebuffer size changes

pub fn on_resize(&self) -> Result<bool, VulkanError>

When the windows was resized, call this method to recreate the swapchain to fit the new size

pub fn begin_scene<'a>( &'a self, pool_index: usize, rt_props: Option<Arc<RenderTargetProps>>, ) -> Result<VulkanContextScene<'a>, VulkanError>

Acquire a command buffer and a queue, start recording the commands

• You could call this function in different threads, in order to achieve concurrent frame rendering

Trait Implementations

impl Debug for VulkanContext

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

Formats the value using the given formatter.

impl Drop for VulkanContext

fn drop(&mut self)

Executes the destructor for this type.

impl Send for VulkanContext

impl Sync for VulkanContext