Struct bedrock::Instance

pub struct Instance(_);

Opaque handle to a instance object

Methods

impl Instance

Following methods are enabled with [feature = "Implements"]

pub fn extra_procedure<F: FnTransmute>(&self, name: &str) -> Option<F>

Return a function pointer for a command

Failures

If function is not provided by instance or name is empty, returns None

pub fn enumerate_physical_devices(&self) -> Result<Vec<PhysicalDevice>>

Enumerates the physical devices accessible to a Vulkan instance

Failures

On failure, this command returns

• VK_ERROR_OUT_OF_HOST_MEMORY
• VK_ERROR_OUT_OF_DEVICE_MEMORY
• VK_ERROR_INITIALIZATION_FAILED

pub fn iter_physical_devices(&self) -> Result<IterPhysicalDevices>

Lazyly enumerates the physical devices accessible to a Vulkan instance

Failures

On failure, this command returns

• VK_ERROR_OUT_OF_HOST_MEMORY
• VK_ERROR_OUT_OF_DEVICE_MEMORY
• VK_ERROR_INITIALIZATION_FAILED

pub fn enumerate_layer_properties() -> Result<Vec<VkLayerProperties>>

Returns up to all of global layer properties

Failures

On failure, this command returns

• VK_ERROR_OUT_OF_HOST_MEMORY
• VK_ERROR_OUT_OF_DEVICE_MEMORY

pub fn enumerate_extension_properties(
    layer_name: Option<&str>
) -> Result<Vec<VkExtensionProperties>>

Returns up to all of global extension properties

Failures

On failure, this command returns

• VK_ERROR_OUT_OF_HOST_MEMORY
• VK_ERROR_OUT_OF_DEVICE_MEMORY
• VK_ERROR_LAYER_NOT_PRESENT

impl Instance

pub fn debug_message(
    &self,
    flags: VkDebugReportFlagsEXT,
    object_type: DebugReportObjectType,
    object: u64,
    location: size_t,
    message_count: i32,
    layer_prefix: &str,
    message: &str
)

Inject its own messages into the debug stream

Trait Implementations

impl Clone for Instance

fn clone(&self) -> Instance

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl VkHandle for Instance

type Handle = VkInstance

fn native_ptr(&self) -> VkInstance

Retrieve an underlying handle