Struct InstanceObject 

pub struct InstanceObject { /* private fields */ }

Opaque handle to a instance object

Implementations

impl InstanceObject

pub fn new(info: &InstanceCreateInfo<'_>) -> Result<Self>

Create a new Vulkan instance

Failures

On failure, this command returns

• brvk::VK_ERROR_OUT_OF_HOST_MEMORY
• brvk::VK_ERROR_OUT_OF_DEVICE_MEMORY
• brvk::VK_ERROR_INITIALIZATION_FAILED
• brvk::VK_ERROR_LAYER_NOT_PRESENT
• brvk::VK_ERROR_EXTENSION_NOT_PRESENT
• brvk::VK_ERROR_INCOMPATIBLE_DRIVER

pub const unsafe fn manage(handle: VkInstance) -> Self

Constructs from raw handle

Safety

the handle must be valid and not freed

pub const fn unmanage(self) -> VkInstance

Purges internal values (Drop will not be called for this resource)

Trait Implementations

impl Drop for InstanceObject

Available on crate feature Implements only.

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.

impl Instance for InstanceObject

fn extra_procedure(&self, name: &CStr) -> Option<PFN_vkVoidFunction>

👎Deprecated:

do not use this directly(this does not provide caching!)

Return a function pointer for a command

fn physical_device_count(&self) -> Result<u32>

Counts the physical devices accessible to a Vulkan instance

fn enumerate_physical_devices( &self, sink: &mut [MaybeUninit<VkPhysicalDevice>], ) -> Result<ArrayQueryResult<u32>>

Enumerates the physical devices accessible to a Vulkan instance

fn iter_physical_devices<'a>(&'a self) -> Result<IterPhysicalDevices<'a, Self>>

Lazyly enumerates the physical devices accessible to a Vulkan instance

fn enumerate_physical_devices_alloc( &self, ) -> Result<Vec<PhysicalDeviceObject<&Self>>>

Enumerates the physical devices accessible to a Vulkan instance

impl InstanceGetPhysicalDeviceProperties2Extension for InstanceObject

Available on crate feature VK_KHR_get_physical_device_properties2 only.

fn get_physical_device_properties2_khr_fn( &self, ) -> PFN_vkGetPhysicalDeviceProperties2KHR

fn get_physical_device_features2_khr_fn( &self, ) -> PFN_vkGetPhysicalDeviceFeatures2KHR

fn get_physical_device_format_properties2_khr_fn( &self, ) -> PFN_vkGetPhysicalDeviceFormatProperties2KHR

impl VkHandle for InstanceObject

type Handle = VkInstance

fn native_ptr(&self) -> Self::Handle

Retrieve an underlying handle

fn as_transparent_ref<'a>(&'a self) -> VkHandleRef<'a, Self::Handle>

impl VkHandleMut for InstanceObject

fn native_ptr_mut(&mut self) -> Self::Handle

Retrieve an underlying mutable handle

fn as_transparent_ref_mut<'a>(&'a mut self) -> VkHandleRefMut<'a, Self::Handle>

impl VkObject for InstanceObject

const TYPE: VkObjectType = brvk::VK_OBJECT_TYPE_INSTANCE

impl Send for InstanceObject

impl Sync for InstanceObject