Struct ash::Instance

source · [−]

pub struct Instance { /* private fields */ }

Expand description

https://www.khronos.org/registry/vulkan/specs/1.3-extensions/man/html/VkInstance.html

Implementations

source

impl Instance

Vulkan core 1.3

source

pub fn fp_v1_3(&self) -> &InstanceFnV1_3

source

pub unsafe fn get_physical_device_tool_properties_len(
&self,
physical_device: PhysicalDevice
) -> VkResult<usize>

Retrieve the number of elements to pass to get_physical_device_tool_properties()

source

pub unsafe fn get_physical_device_tool_properties(
 &self,
 physical_device: PhysicalDevice,
 out: &mut [PhysicalDeviceToolProperties ]
) -> VkResult<()>

https://www.khronos.org/registry/vulkan/specs/1.3-extensions/man/html/vkGetPhysicalDeviceToolProperties.html

Call get_physical_device_tool_properties_len() to query the number of elements to pass to out. Be sure to Default::default()-initialize these elements and optionally set their p_next pointer.

source

impl Instance

Vulkan core 1.1

source

pub fn fp_v1_1(&self) -> &InstanceFnV1_1

source

pub unsafe fn enumerate_physical_device_groups_len(&self) -> VkResult<usize>

Retrieve the number of elements to pass to enumerate_physical_device_groups()

source

pub unsafe fn enumerate_physical_device_groups(
&self,
out: &mut [PhysicalDeviceGroupProperties ]
) -> VkResult<()>

https://www.khronos.org/registry/vulkan/specs/1.3-extensions/man/html/vkEnumeratePhysicalDeviceGroups.html

Call enumerate_physical_device_groups_len() to query the number of elements to pass to out. Be sure to Default::default()-initialize these elements and optionally set their p_next pointer.

source

pub unsafe fn get_physical_device_features2(
    &self,
    physical_device: PhysicalDevice,
    features: &mut PhysicalDeviceFeatures2
)

https://www.khronos.org/registry/vulkan/specs/1.3-extensions/man/html/vkGetPhysicalDeviceFeatures2.html

source

pub unsafe fn get_physical_device_properties2(
    &self,
    physical_device: PhysicalDevice,
    prop: &mut PhysicalDeviceProperties2
)

https://www.khronos.org/registry/vulkan/specs/1.3-extensions/man/html/vkGetPhysicalDeviceProperties2.html

source

pub unsafe fn get_physical_device_format_properties2(
    &self,
    physical_device: PhysicalDevice,
    format: Format,
    out: &mut FormatProperties2
)

https://www.khronos.org/registry/vulkan/specs/1.3-extensions/man/html/vkGetPhysicalDeviceFormatProperties2.html

source

pub unsafe fn get_physical_device_image_format_properties2(
 &self,
 physical_device: PhysicalDevice,
 format_info: &PhysicalDeviceImageFormatInfo2,
 image_format_prop: &mut ImageFormatProperties2
) -> VkResult<()>

https://www.khronos.org/registry/vulkan/specs/1.3-extensions/man/html/vkGetPhysicalDeviceImageFormatProperties2.html

source

pub unsafe fn get_physical_device_queue_family_properties2_len(
&self,
physical_device: PhysicalDevice
) -> usize

Retrieve the number of elements to pass to get_physical_device_queue_family_properties2()

source

pub unsafe fn get_physical_device_queue_family_properties2(
    &self,
    physical_device: PhysicalDevice,
    out: &mut [QueueFamilyProperties2 ]
)

https://www.khronos.org/registry/vulkan/specs/1.3-extensions/man/html/vkGetPhysicalDeviceQueueFamilyProperties2.html

Call get_physical_device_queue_family_properties2_len() to query the number of elements to pass to out. Be sure to Default::default()-initialize these elements and optionally set their p_next pointer.

source

pub unsafe fn get_physical_device_memory_properties2(
    &self,
    physical_device: PhysicalDevice,
    out: &mut PhysicalDeviceMemoryProperties2
)

https://www.khronos.org/registry/vulkan/specs/1.3-extensions/man/html/vkGetPhysicalDeviceMemoryProperties2.html

source

pub unsafe fn get_physical_device_sparse_image_format_properties2_len(
    &self,
    physical_device: PhysicalDevice,
    format_info: &PhysicalDeviceSparseImageFormatInfo2
) -> usize

Retrieve the number of elements to pass to get_physical_device_sparse_image_format_properties2()

source

pub unsafe fn get_physical_device_sparse_image_format_properties2(
    &self,
    physical_device: PhysicalDevice,
    format_info: &PhysicalDeviceSparseImageFormatInfo2,
    out: &mut [SparseImageFormatProperties2 ]
)

https://www.khronos.org/registry/vulkan/specs/1.3-extensions/man/html/vkGetPhysicalDeviceSparseImageFormatProperties2.html

Call get_physical_device_sparse_image_format_properties2_len() to query the number of elements to pass to out. Be sure to Default::default()-initialize these elements and optionally set their p_next pointer.

source

pub unsafe fn get_physical_device_external_buffer_properties(
    &self,
    physical_device: PhysicalDevice,
    external_buffer_info: &PhysicalDeviceExternalBufferInfo,
    out: &mut ExternalBufferProperties
)

https://www.khronos.org/registry/vulkan/specs/1.3-extensions/man/html/vkGetPhysicalDeviceExternalBufferProperties.html

source

pub unsafe fn get_physical_device_external_fence_properties(
    &self,
    physical_device: PhysicalDevice,
    external_fence_info: &PhysicalDeviceExternalFenceInfo,
    out: &mut ExternalFenceProperties
)

https://www.khronos.org/registry/vulkan/specs/1.3-extensions/man/html/vkGetPhysicalDeviceExternalFenceProperties.html

source

pub unsafe fn get_physical_device_external_semaphore_properties(
    &self,
    physical_device: PhysicalDevice,
    external_semaphore_info: &PhysicalDeviceExternalSemaphoreInfo,
    out: &mut ExternalSemaphoreProperties
)

https://www.khronos.org/registry/vulkan/specs/1.3-extensions/man/html/vkGetPhysicalDeviceExternalSemaphoreProperties.html

source

impl Instance

Vulkan core 1.0

source

pub fn fp_v1_0(&self) -> &InstanceFnV1_0

source

pub unsafe fn create_device(
 &self,
 physical_device: PhysicalDevice,
 create_info: &DeviceCreateInfo,
 allocation_callbacks: Option<&AllocationCallbacks>
) -> VkResult<Device>

https://www.khronos.org/registry/vulkan/specs/1.3-extensions/man/html/vkCreateDevice.html

Safety

In order for the created Device to be valid for the duration of its usage, the Instance this was called on must be dropped later than the resulting Device.

source

pub unsafe fn get_device_proc_addr(
    &self,
    device: Device,
    p_name: *const c_char
) -> PFN_vkVoidFunction

https://www.khronos.org/registry/vulkan/specs/1.3-extensions/man/html/vkGetDeviceProcAddr.html

source

pub unsafe fn destroy_instance(
&self,
allocation_callbacks: Option<&AllocationCallbacks>
)

https://www.khronos.org/registry/vulkan/specs/1.3-extensions/man/html/vkDestroyInstance.html

source

pub unsafe fn get_physical_device_format_properties(
    &self,
    physical_device: PhysicalDevice,
    format: Format
) -> FormatProperties

https://www.khronos.org/registry/vulkan/specs/1.3-extensions/man/html/vkGetPhysicalDeviceFormatProperties.html

source

pub unsafe fn get_physical_device_image_format_properties(
 &self,
 physical_device: PhysicalDevice,
 format: Format,
 typ: ImageType,
 tiling: ImageTiling,
 usage: ImageUsageFlags,
 flags: ImageCreateFlags
) -> VkResult<ImageFormatProperties>

https://www.khronos.org/registry/vulkan/specs/1.3-extensions/man/html/vkGetPhysicalDeviceImageFormatProperties.html

source

pub unsafe fn get_physical_device_memory_properties(
&self,
physical_device: PhysicalDevice
) -> PhysicalDeviceMemoryProperties

https://www.khronos.org/registry/vulkan/specs/1.3-extensions/man/html/vkGetPhysicalDeviceMemoryProperties.html

source

pub unsafe fn get_physical_device_properties(
&self,
physical_device: PhysicalDevice
) -> PhysicalDeviceProperties

https://www.khronos.org/registry/vulkan/specs/1.3-extensions/man/html/vkGetPhysicalDeviceProperties.html

source

pub unsafe fn get_physical_device_queue_family_properties(
&self,
physical_device: PhysicalDevice
) -> Vec<QueueFamilyProperties>

https://www.khronos.org/registry/vulkan/specs/1.3-extensions/man/html/vkGetPhysicalDeviceQueueFamilyProperties.html

source

pub unsafe fn get_physical_device_features(
&self,
physical_device: PhysicalDevice
) -> PhysicalDeviceFeatures

https://www.khronos.org/registry/vulkan/specs/1.3-extensions/man/html/vkGetPhysicalDeviceFeatures.html

source

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

https://www.khronos.org/registry/vulkan/specs/1.3-extensions/man/html/vkEnumeratePhysicalDevices.html

source

pub unsafe fn enumerate_device_extension_properties(
&self,
device: PhysicalDevice
) -> VkResult<Vec<ExtensionProperties>>

https://www.khronos.org/registry/vulkan/specs/1.3-extensions/man/html/vkEnumerateDeviceExtensionProperties.html

source

pub unsafe fn enumerate_device_layer_properties(
&self,
device: PhysicalDevice
) -> VkResult<Vec<LayerProperties>>

https://www.khronos.org/registry/vulkan/specs/1.3-extensions/man/html/vkEnumerateDeviceLayerProperties.html

source

pub unsafe fn get_physical_device_sparse_image_format_properties(
 &self,
 physical_device: PhysicalDevice,
 format: Format,
 typ: ImageType,
 samples: SampleCountFlags,
 usage: ImageUsageFlags,
 tiling: ImageTiling
) -> Vec<SparseImageFormatProperties>

https://www.khronos.org/registry/vulkan/specs/1.3-extensions/man/html/vkGetPhysicalDeviceSparseImageFormatProperties.html

Trait Implementations

source

impl Clone for Instance

source

fn clone(&self) -> Instance

Returns a copy of the value. Read more

1.0.0 · source

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

Performs copy-assignment from source. Read more

Auto Trait Implementations

impl RefUnwindSafe for Instance

impl Send for Instance

impl Sync for Instance

impl Unpin for Instance

impl UnwindSafe for Instance

Blanket Implementations

source

impl<T> Any for T where
T: 'static + ?Sized,

source

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source

impl<T> Borrow<T> for T where
T: ?Sized,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

impl<T> BorrowMut<T> for T where
T: ?Sized,

const: unstable · source

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

source

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

source

impl<T, U> Into for T where
U: From<T>,

const: unstable · source

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source

impl<T> ToOwned for T where
T: Clone,

type Owned = T

The resulting type after obtaining ownership.

source

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

source

fn clone_into(&self, target: &mut T)

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

Uses borrowed data to replace owned data, usually by cloning. Read more

source

impl<T, U> TryFrom for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

source

impl<T, U> TryInto for T where
U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

Struct ash::Instance

Implementations

impl Instance

pub unsafe fn load(static_fn: &StaticFn, instance: Instance) -> Self

pub fn handle(&self) -> Instance

impl Instance

pub fn fp_v1_3(&self) -> &InstanceFnV1_3

pub unsafe fn get_physical_device_tool_properties_len( &self, physical_device: PhysicalDevice) -> VkResult<usize>

pub unsafe fn get_physical_device_tool_properties( &self, physical_device: PhysicalDevice, out: &mut [PhysicalDeviceToolProperties]) -> VkResult<()>

impl Instance

pub fn fp_v1_2(&self) -> &InstanceFnV1_2

impl Instance

pub fn fp_v1_1(&self) -> &InstanceFnV1_1

pub unsafe fn enumerate_physical_device_groups_len(&self) -> VkResult<usize>

pub unsafe fn enumerate_physical_device_groups( &self, out: &mut [PhysicalDeviceGroupProperties]) -> VkResult<()>

pub unsafe fn get_physical_device_features2( &self, physical_device: PhysicalDevice, features: &mut PhysicalDeviceFeatures2)

pub unsafe fn get_physical_device_properties2( &self, physical_device: PhysicalDevice, prop: &mut PhysicalDeviceProperties2)

pub unsafe fn get_physical_device_format_properties2( &self, physical_device: PhysicalDevice, format: Format, out: &mut FormatProperties2)

pub unsafe fn get_physical_device_image_format_properties2( &self, physical_device: PhysicalDevice, format_info: &PhysicalDeviceImageFormatInfo2, image_format_prop: &mut ImageFormatProperties2) -> VkResult<()>

pub unsafe fn get_physical_device_queue_family_properties2_len( &self, physical_device: PhysicalDevice) -> usize

pub unsafe fn get_physical_device_queue_family_properties2( &self, physical_device: PhysicalDevice, out: &mut [QueueFamilyProperties2])

pub unsafe fn get_physical_device_memory_properties2( &self, physical_device: PhysicalDevice, out: &mut PhysicalDeviceMemoryProperties2)

pub unsafe fn get_physical_device_sparse_image_format_properties2_len( &self, physical_device: PhysicalDevice, format_info: &PhysicalDeviceSparseImageFormatInfo2) -> usize

pub unsafe fn get_physical_device_sparse_image_format_properties2( &self, physical_device: PhysicalDevice, format_info: &PhysicalDeviceSparseImageFormatInfo2, out: &mut [SparseImageFormatProperties2])

pub unsafe fn get_physical_device_external_buffer_properties( &self, physical_device: PhysicalDevice, external_buffer_info: &PhysicalDeviceExternalBufferInfo, out: &mut ExternalBufferProperties)

pub unsafe fn get_physical_device_external_fence_properties( &self, physical_device: PhysicalDevice, external_fence_info: &PhysicalDeviceExternalFenceInfo, out: &mut ExternalFenceProperties)

pub unsafe fn get_physical_device_external_semaphore_properties( &self, physical_device: PhysicalDevice, external_semaphore_info: &PhysicalDeviceExternalSemaphoreInfo, out: &mut ExternalSemaphoreProperties)

impl Instance

pub fn fp_v1_0(&self) -> &InstanceFnV1_0

pub unsafe fn create_device( &self, physical_device: PhysicalDevice, create_info: &DeviceCreateInfo, allocation_callbacks: Option<&AllocationCallbacks>) -> VkResult<Device>

Safety

pub unsafe fn get_device_proc_addr( &self, device: Device, p_name: *const c_char) -> PFN_vkVoidFunction

pub unsafe fn destroy_instance( &self, allocation_callbacks: Option<&AllocationCallbacks>)

pub unsafe fn get_physical_device_format_properties( &self, physical_device: PhysicalDevice, format: Format) -> FormatProperties

pub unsafe fn get_physical_device_image_format_properties( &self, physical_device: PhysicalDevice, format: Format, typ: ImageType, tiling: ImageTiling, usage: ImageUsageFlags, flags: ImageCreateFlags) -> VkResult<ImageFormatProperties>

pub unsafe fn get_physical_device_memory_properties( &self, physical_device: PhysicalDevice) -> PhysicalDeviceMemoryProperties

pub unsafe fn get_physical_device_properties( &self, physical_device: PhysicalDevice) -> PhysicalDeviceProperties

pub unsafe fn get_physical_device_queue_family_properties( &self, physical_device: PhysicalDevice) -> Vec<QueueFamilyProperties>

pub unsafe fn get_physical_device_features( &self, physical_device: PhysicalDevice) -> PhysicalDeviceFeatures

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

pub unsafe fn enumerate_device_extension_properties( &self, device: PhysicalDevice) -> VkResult<Vec<ExtensionProperties>>

pub unsafe fn enumerate_device_layer_properties( &self, device: PhysicalDevice) -> VkResult<Vec<LayerProperties>>

pub unsafe fn get_physical_device_sparse_image_format_properties( &self, physical_device: PhysicalDevice, format: Format, typ: ImageType, samples: SampleCountFlags, usage: ImageUsageFlags, tiling: ImageTiling) -> Vec<SparseImageFormatProperties>

Trait Implementations

impl Clone for Instance

fn clone(&self) -> Instance

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

Auto Trait Implementations

impl RefUnwindSafe for Instance

impl Send for Instance

impl Sync for Instance

impl Unpin for Instance

impl UnwindSafe for Instance

Blanket Implementations

impl<T> Any for T where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

impl<T> Borrow<T> for T where T: ?Sized,

fn borrow(&self) -> &T

impl<T> BorrowMut<T> for T where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

impl<T> From<T> for T

fn from(t: T) -> T

impl<T, U> Into<U> for T where U: From<T>,

fn into(self) -> U

impl<T> ToOwned for T where T: Clone,

type Owned = T

fn to_owned(&self) -> T

fn clone_into(&self, target: &mut T)

impl<T, U> TryFrom<U> for T where U: Into<T>,

type Error = Infallible

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

impl<T, U> TryInto<U> for T where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

pub unsafe fn get_physical_device_tool_properties_len(
&self,
physical_device: PhysicalDevice
) -> VkResult<usize>

pub unsafe fn get_physical_device_tool_properties(
&self,
physical_device: PhysicalDevice,
out: &mut [PhysicalDeviceToolProperties ]
) -> VkResult<()>

pub unsafe fn enumerate_physical_device_groups(
&self,
out: &mut [PhysicalDeviceGroupProperties ]
) -> VkResult<()>

pub unsafe fn get_physical_device_features2(
&self,
physical_device: PhysicalDevice,
features: &mut PhysicalDeviceFeatures2
)

pub unsafe fn get_physical_device_properties2(
&self,
physical_device: PhysicalDevice,
prop: &mut PhysicalDeviceProperties2
)

pub unsafe fn get_physical_device_format_properties2(
&self,
physical_device: PhysicalDevice,
format: Format,
out: &mut FormatProperties2
)

pub unsafe fn get_physical_device_image_format_properties2(
&self,
physical_device: PhysicalDevice,
format_info: &PhysicalDeviceImageFormatInfo2,
image_format_prop: &mut ImageFormatProperties2
) -> VkResult<()>

pub unsafe fn get_physical_device_queue_family_properties2_len(
&self,
physical_device: PhysicalDevice
) -> usize

pub unsafe fn get_physical_device_queue_family_properties2(
&self,
physical_device: PhysicalDevice,
out: &mut [QueueFamilyProperties2 ]
)

pub unsafe fn get_physical_device_memory_properties2(
&self,
physical_device: PhysicalDevice,
out: &mut PhysicalDeviceMemoryProperties2
)

pub unsafe fn get_physical_device_sparse_image_format_properties2_len(
&self,
physical_device: PhysicalDevice,
format_info: &PhysicalDeviceSparseImageFormatInfo2
) -> usize

pub unsafe fn get_physical_device_sparse_image_format_properties2(
&self,
physical_device: PhysicalDevice,
format_info: &PhysicalDeviceSparseImageFormatInfo2,
out: &mut [SparseImageFormatProperties2 ]
)

pub unsafe fn get_physical_device_external_buffer_properties(
&self,
physical_device: PhysicalDevice,
external_buffer_info: &PhysicalDeviceExternalBufferInfo,
out: &mut ExternalBufferProperties
)

pub unsafe fn get_physical_device_external_fence_properties(
&self,
physical_device: PhysicalDevice,
external_fence_info: &PhysicalDeviceExternalFenceInfo,
out: &mut ExternalFenceProperties
)

pub unsafe fn get_physical_device_external_semaphore_properties(
&self,
physical_device: PhysicalDevice,
external_semaphore_info: &PhysicalDeviceExternalSemaphoreInfo,
out: &mut ExternalSemaphoreProperties
)

pub unsafe fn create_device(
&self,
physical_device: PhysicalDevice,
create_info: &DeviceCreateInfo,
allocation_callbacks: Option<&AllocationCallbacks>
) -> VkResult<Device>

pub unsafe fn get_device_proc_addr(
&self,
device: Device,
p_name: *const c_char
) -> PFN_vkVoidFunction

pub unsafe fn destroy_instance(
&self,
allocation_callbacks: Option<&AllocationCallbacks>
)

pub unsafe fn get_physical_device_format_properties(
&self,
physical_device: PhysicalDevice,
format: Format
) -> FormatProperties

pub unsafe fn get_physical_device_image_format_properties(
&self,
physical_device: PhysicalDevice,
format: Format,
typ: ImageType,
tiling: ImageTiling,
usage: ImageUsageFlags,
flags: ImageCreateFlags
) -> VkResult<ImageFormatProperties>

pub unsafe fn get_physical_device_memory_properties(
&self,
physical_device: PhysicalDevice
) -> PhysicalDeviceMemoryProperties

pub unsafe fn get_physical_device_properties(
&self,
physical_device: PhysicalDevice
) -> PhysicalDeviceProperties

pub unsafe fn get_physical_device_queue_family_properties(
&self,
physical_device: PhysicalDevice
) -> Vec<QueueFamilyProperties>

pub unsafe fn get_physical_device_features(
&self,
physical_device: PhysicalDevice
) -> PhysicalDeviceFeatures

pub unsafe fn enumerate_device_extension_properties(
&self,
device: PhysicalDevice
) -> VkResult<Vec<ExtensionProperties>>

pub unsafe fn enumerate_device_layer_properties(
&self,
device: PhysicalDevice
) -> VkResult<Vec<LayerProperties>>

pub unsafe fn get_physical_device_sparse_image_format_properties(
&self,
physical_device: PhysicalDevice,
format: Format,
typ: ImageType,
samples: SampleCountFlags,
usage: ImageUsageFlags,
tiling: ImageTiling
) -> Vec<SparseImageFormatProperties>

impl<T> Any for T where
T: 'static + ?Sized,

impl<T> Borrow<T> for T where
T: ?Sized,

impl<T> BorrowMut<T> for T where
T: ?Sized,

impl<T, U> Into<U> for T where
U: From<T>,

impl<T> ToOwned for T where
T: Clone,

impl<T, U> TryFrom<U> for T where
U: Into<T>,

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,