vulkanalia

https://docs.rs/vulkanalia/
Admin
Vulkanalia provides Vulkan bindings for Rust, offering a thin wrapper around the Vulkan API to...
Tokens:7,969,037
Snippets:49,579
Trust Score:9.7
Update:1 year ago
Show doc for...
Tokens:
Raw
### Vulkanalia Entry API Documentation

Source: https://docs.rs/vulkanalia/vulkanalia/struct.Entry

Comprehensive documentation for Vulkanalia's Entry point, covering instance creation and version retrieval methods. Includes signatures, parameters, return values, and safety notes.

```APIDOC
Entry API:

Entry::version
  Signature: pub fn version(&self) -> VkResult<Version>
  Description: Gets the instance-level version of this Vulkan entry point.
  Returns: A VkResult containing the Vulkan Version on success.
  Source: ../src/vulkanalia/lib.rs#277-297

Entry::create_instance
  Signature: pub unsafe fn create_instance(&self, info: &[InstanceCreateInfo], allocator: Option<&AllocationCallbacks>) -> VkResult<Instance>
  Description: Creates a Vulkan instance using this Vulkan entry point. The safety requirements of Loader::load must be upheld.
  Parameters:
    - info: A slice of InstanceCreateInfo structures defining the instance.
    - allocator: Optional allocation callbacks for Vulkan.
  Returns: A VkResult containing the Vulkan Instance on success.
  Safety: Requires that the Loader::load method on the supplied Loader implementation upholds its safety requirements.
  Source: ../src/vulkanalia/lib.rs#35-53
```

--------------------------------

### Get All DataGraphPipelineDispatchFlagsARM Flags (Rust)

Source: https://docs.rs/vulkanalia/vulkanalia/vk/struct.DataGraphPipelineDispatchFlagsARM

Illustrates how to retrieve a set containing all possible DataGraphPipelineDispatchFlagsARM flags. This is often used as a starting point when all features or states are desired.

```rust
use vulkanalia::vk::DataGraphPipelineDispatchFlagsARM;

let flags: DataGraphPipelineDispatchFlagsARM = DataGraphPipelineDispatchFlagsARM::all();
// 'flags' now holds a set with all available dispatch flags.
```

--------------------------------

### Rust Vulkan Entry Point Creation and Version Check

Source: https://docs.rs/vulkanalia/src/vulkanalia/lib.rs

Details the `Entry` struct for managing Vulkan entry points and provides methods for creating an instance and querying the Vulkan API version.

```rust
/// A Vulkan entry point.
#[derive(Clone)]
pub struct Entry {
    _loader: Arc<dyn Loader>,
    get_instance: vk::PFN_vkGetInstanceProcAddr,
    get_device: vk::PFN_vkGetDeviceProcAddr,
    commands: EntryCommands,
}

impl Entry {
    /// Loads a Vulkan entry point using a Vulkan function loader.
    ///
    /// # Safety
    ///
    /// The [`Loader::load`] method will be called on the supplied [`Loader`]
    /// implementation to load the entry commands so the safety requirements of
    /// [`Loader::load`] for the [`Loader`] implementation used must be upheld.
    #[inline]
    pub unsafe fn new(loader: impl Loader + 'static) -> Result<Self, Box<dyn LoaderError>> {
        let loader = Arc::new(loader);

        type F = extern "system" fn();
        let raw = loader.load(b"vkGetInstanceProcAddr")?;
        let get_instance = mem::transmute::<F, vk::PFN_vkGetInstanceProcAddr>(raw);
        let raw = loader.load(b"vkGetDeviceProcAddr")?;
        let get_device = mem::transmute::<F, vk::PFN_vkGetDeviceProcAddr>(raw);

        let load = |n| get_instance(vk::Instance::null(), n);
        let commands = EntryCommands::load(load);

        Ok(Self {
            _loader: loader,
            get_instance,
            get_device,
            commands,
        })
    }

    /// Gets the instance-level version of this Vulkan entry point.
    #[inline]
    pub fn version(&self) -> VkResult<Version> {
        let name = b"vkEnumerateInstanceVersion\0".as_ptr() as *const c_char;
        let raw = unsafe { (self.get_instance)(vk::Instance::null(), name) };
        let enumerate: Option<vk::PFN_vkEnumerateInstanceVersion> = unsafe { mem::transmute(raw) };
        if let Some(enumerate) = enumerate {
            let mut version = 0;
            match unsafe { enumerate(&mut version) } {
                vk::Result::SUCCESS => Ok(Version::from(version)),
                error => Err(error.into()),
            }
        } else {
            Ok(Version::V1_0_0)
        }
    }

    /// Creates a Vulkan instance using this Vulkan entry point.
    ///
    /// # Safety
    ///
    /// The [`Loader::load`] method will be called on the supplied [`Loader`]
    /// implementation to load the instance commands so the safety requirements
    /// of [`Loader::load`] for the [`Loader`] implementation used must be
    /// upheld.
    #[inline]
    pub unsafe fn create_instance(
        &self,
        info: &vk::InstanceCreateInfo,
        allocator: Option<&vk::AllocationCallbacks>,
    ) -> VkResult<Instance> {
        let handle = EntryV1_0::create_instance(self, info, allocator)?;
        let instance_load = |n| (self.get_instance)(handle, n);
        let commands = InstanceCommands::load(instance_load);
        let version = self.version()?;
        // ... rest of the implementation
        unimplemented!(); // Placeholder for brevity
    }
}
```

--------------------------------

### Get Empty DataGraphPipelineDispatchFlagsARM Flags (Rust)

Source: https://docs.rs/vulkanalia/vulkanalia/vk/struct.DataGraphPipelineDispatchFlagsARM

Demonstrates how to obtain an empty set of DataGraphPipelineDispatchFlagsARM flags. This is useful for starting with no flags set, ensuring a clean state before applying specific flags.

```rust
use vulkanalia::vk::DataGraphPipelineDispatchFlagsARM;

let flags: DataGraphPipelineDispatchFlagsARM = DataGraphPipelineDispatchFlagsARM::empty();
// 'flags' now holds an empty set of dispatch flags.
```

--------------------------------

### Vulkanalia Instance API Documentation

Source: https://docs.rs/vulkanalia/vulkanalia/struct.Instance

Comprehensive API documentation for the Vulkanalia Instance struct, detailing its methods for interacting with Vulkan instances, querying properties, and managing device creation.

```APIDOC
Struct Instance
  Represents a Vulkan instance.

  Methods:
  - version(&self) -> Version
    Gets the version for this Vulkan instance.
    Returns: A Version struct representing the Vulkan API version.

  - extensions(&self) -> &[BTreeSet<ExtensionName>]
    Gets the loaded extensions for this Vulkan instance.
    Returns: A slice of BTreeSet containing ExtensionName for loaded extensions.

  - layers(&self) -> &[BTreeSet<ExtensionName>]
    Gets the loaded layers for this Vulkan instance.
    Returns: A slice of BTreeSet containing ExtensionName for loaded layers.

  - unsafe create_device(&self, physical_device: PhysicalDevice, info: &DeviceCreateInfo, allocator: Option<&AllocationCallbacks>) -> VkResult<Device>
    Creates a Vulkan device using this Vulkan instance.
    Safety: The Loader::load method will be called on the supplied Loader implementation to load the device commands. Uphold safety requirements of Loader::load.
    Parameters:
      physical_device: The PhysicalDevice to create the device from.
      info: DeviceCreateInfo specifying the device's properties and features.
      allocator: Optional allocation callbacks.
    Returns: A VkResult containing the created Device or an error.

  Trait Implementations:
  - impl Clone for Instance
    fn clone(&self) -> Instance
      Returns a duplicate of the value.
      Source: https://doc.rust-lang.org/nightly/src/core/clone.rs.html#213-215
```

--------------------------------

### Vulkan API Get Functions

Source: https://docs.rs/vulkanalia/vulkanalia/vk/struct.DeviceCommands

This section documents various Vulkan API functions that start with 'get_'. These functions are typically used to retrieve information, handles, or properties from the Vulkan system. Each entry includes the function name and its corresponding Vulkan function pointer type alias as defined in the Vulkanalia Rust crate.

```APIDOC
Vulkan API Get Functions:

This block consolidates various Vulkan API functions prefixed with 'get_'. These functions are crucial for querying the Vulkan driver and device for specific information, capabilities, or resources.

Function Signatures and Types:

- get_device_subpass_shading_max_workgroup_size_huawei: PFN_vkGetDeviceSubpassShadingMaxWorkgroupSizeHUAWEI
  - Description: Retrieves the maximum workgroup size for subpass shading.
  - Related: Other device-specific query functions.

- get_device_tensor_memory_requirements_arm: PFN_vkGetDeviceTensorMemoryRequirementsARM
  - Description: Retrieves memory requirements for tensor operations on ARM devices.
  - Related: Memory management functions.

- get_dynamic_rendering_tile_properties_qcom: PFN_vkGetDynamicRenderingTilePropertiesQCOM
  - Description: Retrieves tile properties for dynamic rendering.
  - Related: Rendering pipeline configuration.

- get_encoded_video_session_parameters_khr: PFN_vkGetEncodedVideoSessionParametersKHR
  - Description: Retrieves encoded video session parameters.
  - Related: Video encoding/decoding functions.

- get_event_status: PFN_vkGetEventStatus
  - Description: Retrieves the status of a Vulkan event.
  - Related: Event synchronization primitives.

- get_execution_graph_pipeline_node_index_amdx: PFN_vkGetExecutionGraphPipelineNodeIndexAMDX
  - Description: Retrieves the node index within an execution graph pipeline.
  - Related: Graphics pipeline management.

- get_execution_graph_pipeline_scratch_size_amdx: PFN_vkGetExecutionGraphPipelineScratchSizeAMDX
  - Description: Retrieves the scratch memory size required for an execution graph pipeline.
  - Related: Graphics pipeline management.

- get_external_compute_queue_data_nv: PFN_vkGetExternalComputeQueueDataNV
  - Description: Retrieves external compute queue data.
  - Related: Interoperability with other APIs.

- get_fence_fd_khr: PFN_vkGetFenceFdKHR
  - Description: Retrieves a file descriptor for a Vulkan fence.
  - Related: Cross-process synchronization.

- get_fence_sci_sync_fence_nv: PFN_vkGetFenceSciSyncFenceNV
  - Description: Retrieves a SciSync fence object for a Vulkan fence.
  - Related: Synchronization primitives.

- get_fence_sci_sync_obj_nv: PFN_vkGetFenceSciSyncObjNV
  - Description: Retrieves a SciSync object for a Vulkan fence.
  - Related: Synchronization primitives.

- get_fence_status: PFN_vkGetFenceStatus
  - Description: Retrieves the status of a Vulkan fence.
  - Related: Fence synchronization primitives.

- get_fence_win32_handle_khr: PFN_vkGetFenceWin32HandleKHR
  - Description: Retrieves a Windows HANDLE for a Vulkan fence.
  - Related: Cross-process synchronization on Windows.

- get_framebuffer_tile_properties_qcom: PFN_vkGetFramebufferTilePropertiesQCOM
  - Description: Retrieves tile properties for a framebuffer.
  - Related: Framebuffer and rendering configuration.

- get_generated_commands_memory_requirements_ext: PFN_vkGetGeneratedCommandsMemoryRequirementsEXT
  - Description: Retrieves memory requirements for generated commands.
  - Related: Command buffer generation.

- get_generated_commands_memory_requirements_nv: PFN_vkGetGeneratedCommandsMemoryRequirementsNV
  - Description: Retrieves memory requirements for generated commands.
  - Related: Command buffer generation.

- get_image_drm_format_modifier_properties_ext: PFN_vkGetImageDrmFormatModifierPropertiesEXT
  - Description: Retrieves DRM format modifier properties for an image.
  - Related: Image format and memory management.

- get_image_memory_requirements: PFN_vkGetImageMemoryRequirements
  - Description: Retrieves memory requirements for a Vulkan image.
  - Related: Image memory allocation.

- get_image_memory_requirements2: PFN_vkGetImageMemoryRequirements2
  - Description: Retrieves memory requirements for a Vulkan image with extended information.
  - Related: Image memory allocation.

- get_image_memory_requirements2_khr: PFN_vkGetImageMemoryRequirements2KHR
  - Description: Retrieves memory requirements for a Vulkan image with extended information (KHR extension).
  - Related: Image memory allocation.

- get_image_opaque_capture_descriptor_data_ext: PFN_vkGetImageOpaqueCaptureDescriptorDataEXT
  - Description: Retrieves opaque capture descriptor data for an image.
  - Related: Descriptor management and debugging.

Note: Detailed parameter, return value, and usage examples are not provided in the source text but can be found in the official Vulkan specification and Vulkanalia documentation.
```

--------------------------------

### Vulkan Get Private Data

Source: https://docs.rs/vulkanalia/vulkanalia/vk/struct.DeviceCommands

This entry covers Vulkan API functions for getting and setting private data associated with Vulkan objects. This allows applications to attach arbitrary key-value pairs to objects.

```APIDOC
vkGetPrivateData: PFN_vkGetPrivateData
  - Retrieves private data associated with a Vulkan object.

vkGetPrivateDataEXT: PFN_vkGetPrivateDataEXT
  - Retrieves private data associated with a Vulkan object (extension).
```

--------------------------------

### APIDOC: Vulkan Entry Point Functions

Source: https://docs.rs/vulkanalia/src/vulkanalia/lib.rs

Documentation for core Vulkan entry point functions, including instance creation and procedure address retrieval.

```APIDOC
vkGetInstanceProcAddr(instance, pName)
  - Retrieves the address of a Vulkan command for a given instance.
  - Parameters:
    - instance: Handle to the Vulkan instance.
    - pName: Pointer to a null-terminated string representing the command name.
  - Returns: Pointer to the command function, or NULL if not found.

vkEnumerateInstanceVersion(pApiVersion)
  - Queries the Vulkan instance API version.
  - Parameters:
    - pApiVersion: Pointer to a uint32_t to store the version number.
  - Returns:
    - vk::Result::SUCCESS: Version successfully retrieved.
    - Other vk::Result codes: An error occurred.

vkCreateInstance(pCreateInfo, pAllocator, pInstance)
  - Creates a Vulkan instance.
  - Parameters:
    - pCreateInfo: Pointer to a vk::InstanceCreateInfo structure.
    - pAllocator: Pointer to vk::AllocationCallbacks (optional).
    - pInstance: Pointer to a vk::Instance handle to be returned.
  - Returns:
    - vk::Result::SUCCESS: Instance created successfully.
    - Other vk::Result codes: An error occurred.
```

--------------------------------

### PhysicalDeviceImageDrmFormatModifierInfoEXT Cast Trait

Source: https://docs.rs/vulkanalia/vulkanalia/vk/struct.PhysicalDeviceImageDrmFormatModifierInfoEXT

API documentation for the `Cast` trait implementation for `PhysicalDeviceImageDrmFormatModifierInfoEXT`. This trait enables FFI-safe conversions, providing methods to convert the struct into its target type (`into`), get an immutable reference (`as_ref`), and get a mutable reference (`as_mut`).

```APIDOC
impl Cast for PhysicalDeviceImageDrmFormatModifierInfoEXT
  type Target = PhysicalDeviceImageDrmFormatModifierInfoEXT
    Converts this value into a value of the other type.
  fn into(self) -> Self::Target

  fn as_ref(&self) -> &Self::Target
    Converts this reference into a reference to the other type.

  fn as_mut(&mut self) -> &mut Self::Target
    Converts this mutable reference into a mutable reference to the other type.
```

--------------------------------

### Vulkanalia Entry Struct and Methods

Source: https://docs.rs/vulkanalia/vulkanalia/struct.Entry

Documentation for the vulkanalia Entry struct, including its constructor and other methods. This section details how to create a Vulkan entry point and interact with Vulkan versions.

```APIDOC
Struct Entry

Source: ../src/vulkanalia/lib.rs.html#215-220

pub struct Entry { /* private fields */ }

A Vulkan entry point.

Implementations:

impl Entry

  pub unsafe fn new(loader: impl Loader + 'static) -> Result<Self, Box<dyn LoaderError>>
    Loads a Vulkan entry point using a Vulkan function loader.
    Parameters:
      loader: An object implementing the Loader trait, which provides functions for loading Vulkan entry points.
    Returns:
      A Result containing the Entry struct on success, or a Boxed LoaderError on failure.

  pub unsafe fn create_instance(...) -> ...
    (Details for create_instance method would go here if provided)

  pub fn version(...) -> ...
    (Details for version method would go here if provided)

Trait Implementations:

- Clone for Entry
- Debug for Entry
- EntryV1_0 for Entry
- EntryV1_1 for Entry
- EntryV1_2 for Entry
- EntryV1_3 for Entry
- EntryV1_4 for Entry
- Send for Entry
- Sync for Entry

Auto Trait Implementations:

- !RefUnwindSafe for Entry
- !UnwindSafe for Entry
- Freeze for Entry
- Unpin for Entry

Blanket Implementations:

- Any for T
- Borrow<T> for T
- BorrowMut<T> for T
- CloneToUninit for T
- From<T> for T
- Into<U> for T
- ToOwned for T
- TryFrom<U> for T
- TryInto<U> for T
```

--------------------------------

### Implement Any for T

Source: https://docs.rs/vulkanalia/vulkanalia/vk/struct.ImageViewSampleWeightCreateInfoQCOMBuilder

Provides a way to get the TypeId of any type T that is 'static and Sized. This is a blanket implementation.

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

--------------------------------

### InstanceCreateInfo API Documentation

Source: https://docs.rs/vulkanalia/vulkanalia/vk/struct.InstanceCreateInfo

Comprehensive documentation for the InstanceCreateInfo struct, covering its methods and trait implementations for equality, copying, and safety.

```APIDOC
struct InstanceCreateInfo
  - Represents Vulkan's VkInstanceCreateInfo structure.

  Associated Constants:
    TYPE: StructureType
      - The structure type for this struct type.
      - Example: `const TYPE: StructureType = StructureType::INSTANCE_CREATE_INFO;`

  Methods:
    s_type(&self) -> StructureType
      - The structure type for this struct.
      - Returns: The StructureType enum value.

    next(&self) -> *const c_void
      - The next struct in the pointer chain for this struct.
      - Returns: A raw pointer to the next structure in the chain, or null if none.

  Trait Implementations:
    impl PartialEq for InstanceCreateInfo
      - Provides equality comparison for InstanceCreateInfo structs.
      - eq(&self, other: &InstanceCreateInfo) -> bool
        - Tests for `self` and `other` values to be equal, and is used by `==`.
      - ne(&self, other: &InstanceCreateInfo) -> bool
        - Tests for `!=`.

    impl Copy for InstanceCreateInfo
      - Allows InstanceCreateInfo structs to be copied by value.

    impl Eq for InstanceCreateInfo
      - Marks InstanceCreateInfo as having a total equality relation.

    impl StructuralPartialEq for InstanceCreateInfo
      - Enables structural equality checks.

    impl Freeze for InstanceCreateInfo
      - Indicates that the struct can be frozen (its data cannot be mutated).

    impl RefUnwindSafe for InstanceCreateInfo
      - Guarantees that references to InstanceCreateInfo are safe to unwind across.

    impl Send for InstanceCreateInfo
      - Indicates that InstanceCreateInfo can be safely sent between threads.

    impl Sync for InstanceCreateInfo
      - Indicates that references to InstanceCreateInfo can be safely shared between threads.

    impl Unpin for InstanceCreateInfo
      - Guarantees that InstanceCreateInfo is Unpin, meaning its memory address is stable.

    impl UnwindSafe for InstanceCreateInfo
      - Guarantees that InstanceCreateInfo is safe to unwind across.
```

--------------------------------

### Generic Any Trait Implementation

Source: https://docs.rs/vulkanalia/vulkanalia/vk/struct.TensorMemoryBarrierARMBuilder

Blanket implementation of the Any trait for any type T, providing a method to get the TypeId.

```rust
impl<T> Any for T where T: 'static + ?Sized,
{
    fn type_id(&self) -> TypeId
}
```

--------------------------------

### DeviceFaultVendorBinaryHeaderVersionOneEXTBuilder Methods

Source: https://docs.rs/vulkanalia/vulkanalia/vk/struct.DeviceFaultVendorBinaryHeaderVersionOneEXTBuilder

Lists the available methods for the DeviceFaultVendorBinaryHeaderVersionOneEXTBuilder struct in the vulkanalia crate. Detailed signatures and parameter descriptions are not provided in the source text.

```APIDOC
DeviceFaultVendorBinaryHeaderVersionOneEXTBuilder:
  api_version()
  application_name_offset()
  application_version()
  build()
  device_id()
  driver_version()
  engine_name_offset()
  engine_version()
  header_size()
  header_version()
  pipeline_cache_uuid()
  vendor_id()
```

--------------------------------

### vulkanalia 0.29.0 Crate Overview

Source: https://docs.rs/vulkanalia/vulkanalia/vk/struct.DeviceSemaphoreSciSyncPoolReservationCreateInfoNVBuilder

Provides an overview of the vulkanalia crate, including its version, license, repository links, and dependencies. It highlights the documentation status and available platform targets.

```rust
Project: /context7/rs-vulkanalia

* vulkanalia-0.29.0

  + vulkanalia 0.29.0
  + [Permalink](/vulkanalia/0.29.0/vulkanalia/vk/struct.DeviceSemaphoreSciSyncPoolReservationCreateInfoNVBuilder.html "Get a link to this specific version")
  + [Docs.rs crate page](/crate/vulkanalia/latest "See vulkanalia in docs.rs")
  + [Apache-2.0](https://spdx.org/licenses/Apache-2.0)

  + Links
  + [Repository](https://github.com/KyleMayes/vulkanalia)
  + [crates.io](https://crates.io/crates/vulkanalia "See vulkanalia in crates.io")
  + [Source](/crate/vulkanalia/latest/source/ "Browse source of vulkanalia-0.29.0")

  + Owners
  + [KyleMayes](https://crates.io/users/KyleMayes)

  + Dependencies
  + - [libloading ^0.8.5
      *normal*
      *optional*](/libloading/%5E0.8.5)
    - [raw-window-handle ^0.6
      *normal*
      *optional*](/raw-window-handle/%5E0.6)
    - [vulkanalia-sys ^0.29
      *normal*](/vulkanalia-sys/%5E0.29)
    - [cocoa ^0.25
      *normal*
      *optional*](/cocoa/%5E0.25)
    - [metal ^0.27
      *normal*
      *optional*](/metal/%5E0.27)
    - [objc ^0.2
      *normal*
      *optional*](/objc/%5E0.2)

  + Versions

  + [**80.38%**
    of the crate is documented](/crate/vulkanalia/latest)
* Platform
  + [i686-pc-windows-msvc](/crate/vulkanalia/latest/target-redirect/i686-pc-windows-msvc/vulkanalia/vk/struct.DeviceSemaphoreSciSyncPoolReservationCreateInfoNVBuilder.html)
  + [i686-unknown-linux-gnu](/crate/vulkanalia/latest/target-redirect/i686-unknown-linux-gnu/vulkanalia/vk/struct.DeviceSemaphoreSciSyncPoolReservationCreateInfoNVBuilder.html)
  + [x86_64-pc-windows-msvc](/crate/vulkanalia/latest/target-redirect/x86_64-pc-windows-msvc/vulkanalia/vk/struct.DeviceSemaphoreSciSyncPoolReservationCreateInfoNVBuilder.html)
  + [x86_64-unknown-linux-gnu](/crate/vulkanalia/latest/target-redirect/x86_64-unknown-linux-gnu/vulkanalia/vk/struct.DeviceSemaphoreSciSyncPoolReservationCreateInfoNVBuilder.html)
* [Feature flags](/crate/vulkanalia/latest/features "Browse available feature flags of vulkanalia-0.29.0")

* docs.rs
  + [About docs.rs](/about)
  + [Privacy policy](https://foundation.rust-lang.org/policies/privacy-policy/#docs.rs)

* Rust
  + [Rust website](https://www.rust-lang.org/)
  + [The Book](https://doc.rust-lang.org/book/)
  + [Standard Library API Reference](https://doc.rust-lang.org/std/)
  + [Rust by Example](https://doc.rust-lang.org/rust-by-example/)
  + [The Cargo Guide](https://doc.rust-lang.org/cargo/guide/)
  + [Clippy Documentation](https://doc.rust-lang.org/nightly/clippy)
```

--------------------------------

### Get PipelineCreateFlags2CreateInfo Structure Type

Source: https://docs.rs/vulkanalia/vulkanalia/vk/struct.PipelineCreateFlags2CreateInfo

Returns the structure type for the PipelineCreateFlags2CreateInfo struct.

```Rust
fn s_type(&self) -> StructureType
```

--------------------------------

### Vulkan Initialization and Configuration Functions

Source: https://docs.rs/vulkanalia/vulkanalia/vk/struct.DeviceCommands

Functions related to initializing Vulkan subsystems or configuring performance-related aspects of the API.

```APIDOC
initialize_performance_api_intel
  - Initializes the performance API for Intel GPUs.
  - Parameters: Not specified in source.
  - Returns: Not specified in source.

set_buffer_collection_buffer_constraints_fuchsia
  - Sets buffer constraints for a buffer collection in Fuchsia.
  - Parameters: Not specified in source.
  - Returns: Not specified in source.

set_buffer_collection_image_constraints_fuchsia
  - Sets image constraints for a buffer collection in Fuchsia.
  - Parameters: Not specified in source.
  - Returns: Not specified in source.

set_device_memory_priority_ext
  - Sets the memory priority for a Vulkan device.
  - Parameters: Not specified in source.
  - Returns: Not specified in source.

set_hdr_metadata_ext
  - Sets HDR metadata for a swapchain or display.
  - Parameters: Not specified in source.
  - Returns: Not specified in source.

set_latency_marker_nv
  - Sets a latency marker for performance analysis.
  - Parameters: Not specified in source.
  - Returns: Not specified in source.
```

--------------------------------

### Get Structure Type Method

Source: https://docs.rs/vulkanalia/vulkanalia/vk/struct.AcquireProfilingLockInfoKHR

A method that returns the structure type for the AcquireProfilingLockInfoKHR struct.

```rust
fn s_type(&self) -> StructureType;
```

--------------------------------

### Get TypeId for Any

Source: https://docs.rs/vulkanalia/vulkanalia/vk/struct.PhysicalDeviceCooperativeMatrixFeaturesKHR

Provides the method to retrieve the unique TypeId for any type implementing the Any trait.

```rust
fn type_id(&self) -> TypeId
```

--------------------------------

### DeviceGroupCommandBufferBeginInfoBuilder Methods

Source: https://docs.rs/vulkanalia/vulkanalia/vk/struct.DeviceGroupCommandBufferBeginInfoBuilder

Provides methods to configure and build a `DeviceGroupCommandBufferBeginInfo` structure. Includes setting the device mask and finalizing the build process.

```APIDOC
DeviceGroupCommandBufferBeginInfoBuilder:
  device_mask(self, device_mask: u32) -> Self
    Sets the device mask for the command buffer.
    Parameters:
      device_mask: A u32 value representing the mask of devices.
    Returns: The builder instance for chaining.

  build(self) -> DeviceGroupCommandBufferBeginInfo
    Builds and returns the `DeviceGroupCommandBufferBeginInfo` structure.
    Returns: An instance of `DeviceGroupCommandBufferBeginInfo`.
```

--------------------------------

### SamplerReductionModeCreateInfo API Documentation

Source: https://docs.rs/vulkanalia/vulkanalia/vk/struct.SamplerReductionModeCreateInfo

Comprehensive API documentation for the Vulkan `SamplerReductionModeCreateInfo` structure, detailing its purpose, fields, and common usage patterns within Vulkanalia.

```APIDOC
struct SamplerReductionModeCreateInfo {
    // Specifies the reduction mode.
    reduction_mode: SamplerReductionMode
}

// Enum for sampler reduction modes.
enum SamplerReductionMode {
    // Use the nearest texel.
    Nearest,
    // Use the average of texels.
    Average,
    // Use the minimum of texels.
    Min,
    // Use the maximum of texels.
    Max
}

// Trait implementations for SamplerReductionModeCreateInfo:
// - Debug: For formatted output.
// - Default: To create an instance with default values.
// - HasBuilder: To access its associated builder pattern.
// - Hash: To allow hashing of the struct instance.
// - InputChainStruct: For use in Vulkan API chains.
```

--------------------------------

### type_id method for Any trait

Source: https://docs.rs/vulkanalia/vulkanalia/vk/struct.ImageViewSampleWeightCreateInfoQCOMBuilder

Gets the TypeId of self, allowing for runtime type identification. Requires the Any trait.

```rust
fn type_id(&self) -> TypeId
```

--------------------------------

### Instance V1_0 Methods

Source: https://docs.rs/vulkanalia/vulkanalia/struct.Instance

Provides access to core Vulkan 1.0 instance functionalities. Includes methods to retrieve instance commands and the raw instance handle.

```APIDOC
InstanceV1_0::commands

fn commands(&self) -> &InstanceCommands

Retrieves the InstanceCommands structure, which contains function pointers for Vulkan 1.0 instance-level commands.

Returns:
  A reference to the InstanceCommands structure.

InstanceV1_0::handle

fn handle(&self) -> Instance

Returns the raw Vulkan Instance handle.

Returns:
  The Instance handle.
```

--------------------------------

### DescriptorPoolCreateFlags Not Trait

Source: https://docs.rs/vulkanalia/vulkanalia/vk/struct.DescriptorPoolCreateFlags

Implements the `Not` trait for DescriptorPoolCreateFlags, providing a method to get the complement of flags.

```APIDOC
trait Not {
    type Output;
    fn not(self) -> Self::Output;
}

// For DescriptorPoolCreateFlags:
// type Output = DescriptorPoolCreateFlags;
// fn not(self) -> DescriptorPoolCreateFlags;
// Description: Returns the complement of this set of flags.
```

--------------------------------

### vulkanalia Crate Overview

Source: https://docs.rs/vulkanalia/vulkanalia/vk/struct.QueryPoolPerformanceCreateInfoKHR

Provides metadata and links related to the vulkanalia Rust crate, including version, license, repository, dependencies, and documentation status.

```APIDOC
Crate: vulkanalia
Version: 0.29.0
License: Apache-2.0
Repository: https://github.com/KyleMayes/vulkanalia
crates.io: https://crates.io/crates/vulkanalia
Documentation Status: 80.38% documented
Dependencies:
  - libloading ^0.8.5
  - raw-window-handle ^0.6
  - vulkanalia-sys ^0.29
  - cocoa ^0.25 (optional)
  - metal ^0.27 (optional)
  - objc ^0.2 (optional)
Platforms:
  - i686-pc-windows-msvc
  - i686-unknown-linux-gnu
  - x86_64-pc-windows-msvc
  - x86_64-unknown-linux-gnu
```

--------------------------------

### Get Next Pointer in Chain

Source: https://docs.rs/vulkanalia/vulkanalia/vk/struct.AcquireProfilingLockInfoKHR

Retrieves the pointer to the next structure in the chain for the AcquireProfilingLockInfoKHR struct.

```rust
fn next(&self) -> *const c_void;
```

--------------------------------

### Get Structure Type

Source: https://docs.rs/vulkanalia/vulkanalia/vk/struct.VertexInputAttributeDescription2EXT

Returns the structure type for the VertexInputAttributeDescription2EXT struct. This method is part of the InputChainStruct trait.

```rust
fn s_type(&self) -> StructureType;
```

--------------------------------

### vulkanalia 0.29.0 Crate Overview

Source: https://docs.rs/vulkanalia/vulkanalia/vk/struct.VideoEncodeSessionParametersFeedbackInfoKHR

Provides essential information about the vulkanalia crate, including its version, license, repository links, and dependencies. It also highlights the documentation coverage and supported platforms.

```APIDOC
Project: /context7/rs-vulkanalia
Content:
[Docs.rs](/) 
* vulkanalia-0.29.0
  + vulkanalia 0.29.0
  + [Permalink](/vulkanalia/0.29.0/vulkanalia/vk/struct.VideoEncodeSessionParametersFeedbackInfoKHR.html "Get a link to this specific version")
  + [Docs.rs crate page](/crate/vulkanalia/latest "See vulkanalia in docs.rs")
  + [Apache-2.0](https://spdx.org/licenses/Apache-2.0)
  + Links
  + [Repository](https://github.com/KyleMayes/vulkanalia)
  + [crates.io](https://crates.io/crates/vulkanalia "See vulkanalia in crates.io")
  + [Source](/crate/vulkanalia/latest/source/ "Browse source of vulkanalia-0.29.0")
  + Owners
  + [KyleMayes](https://crates.io/users/KyleMayes)
  + Dependencies
  + - [libloading ^0.8.5 *normal* *optional*](/libloading/%5E0.8.5)
    - [raw-window-handle ^0.6 *normal* *optional*](/raw-window-handle/%5E0.6)
    - [vulkanalia-sys ^0.29 *normal*](/vulkanalia-sys/%5E0.29)
    - [cocoa ^0.25 *normal* *optional*](/cocoa/%5E0.25)
    - [metal ^0.27 *normal* *optional*](/metal/%5E0.27)
    - [objc ^0.2 *normal* *optional*](/objc/%5E0.2)
  + Versions
  + [**80.38%** of the crate is documented](/crate/vulkanalia/latest)
* Platform
  + [i686-pc-windows-msvc](/crate/vulkanalia/latest/target-redirect/i686-pc-windows-msvc/vulkanalia/vk/struct.VideoEncodeSessionParametersFeedbackInfoKHR.html)
  + [i686-unknown-linux-gnu](/crate/vulkanalia/latest/target-redirect/i686-unknown-linux-gnu/vulkanalia/vk/struct.VideoEncodeSessionParametersFeedbackInfoKHR.html)
  + [x86_64-pc-windows-msvc](/crate/vulkanalia/latest/target-redirect/x86_64-pc-windows-msvc/vulkanalia/vk/struct.VideoEncodeSessionParametersFeedbackInfoKHR.html)
  + [x86_64-unknown-linux-gnu](/crate/vulkanalia/latest/target-redirect/x86_64-unknown-linux-gnu/vulkanalia/vk/struct.VideoEncodeSessionParametersFeedbackInfoKHR.html)
* [Feature flags](/crate/vulkanalia/latest/features "Browse available feature flags of vulkanalia-0.29.0")
* docs.rs
  + [About docs.rs](/about)
  + [Privacy policy](https://foundation.rust-lang.org/policies/privacy-policy/#docs.rs)
* Rust
  + [Rust website](https://www.rust-lang.org/)
  + [The Book](https://doc.rust-lang.org/book/)
  + [Standard Library API Reference](https://doc.rust-lang.org/std/)
  + [Rust by Example](https://doc.rust-lang.org/rust-by-example/)
  + [The Cargo Guide](https://doc.rust-lang.org/cargo/guide/)
  + [Clippy Documentation](https://doc.rust-lang.org/nightly/clippy)
```

--------------------------------

### SamplerCreateInfo API Documentation

Source: https://docs.rs/vulkanalia/vulkanalia/vk/struct.SamplerCreateInfo

Comprehensive API documentation for the SamplerCreateInfo struct in Vulkanalia, covering its PartialEq, Copy, and other trait implementations.

```APIDOC
SamplerCreateInfo:
  - Implements PartialEq for equality comparison.
    - eq(&self, other: &SamplerCreateInfo) -> bool: Tests for equality.
    - ne(&self, other: &SamplerCreateInfo) -> bool: Tests for inequality.
  - Implements Copy for value copying.
  - Implements StructuralPartialEq.
  - Auto Trait Implementations:
    - Freeze
    - RefUnwindSafe
    - Send
    - Sync
    - Unpin
    - UnwindSafe
  - Blanket Implementations:
    - Any
```

--------------------------------

### Get Default TileMemoryRequirementsQCOMBuilder

Source: https://docs.rs/vulkanalia/vulkanalia/vk/struct.TileMemoryRequirementsQCOMBuilder

Provides the default value for the TileMemoryRequirementsQCOMBuilder struct. This is useful for initializing the builder with standard settings.

```rust
fn default() -> TileMemoryRequirementsQCOMBuilder
```

--------------------------------

### Rust: Any::type_id Method

Source: https://docs.rs/vulkanalia/vulkanalia/vk/struct.SysmemColorSpaceFUCHSIA

Gets the TypeId of self, a unique identifier for the type of a value. This is part of the Any trait.

```rust
fn type_id(&self) -> TypeId
```

--------------------------------

### SamplerCreateInfo API Documentation

Source: https://docs.rs/vulkanalia/vulkanalia/vk/struct.SamplerCreateInfo

Comprehensive documentation for the Vulkanalia SamplerCreateInfo struct, detailing its methods for type casting, cloning, debugging, providing default values, and integrating with the builder pattern.

```APIDOC
Cast Trait Methods for SamplerCreateInfo:

as_ref(&self) -> &Self::Target
  Converts this reference into a reference to the other type.
  Parameters:
    - self: A reference to the object.
  Returns:
    - A reference to the target type.

as_mut(&mut self) -> &mut Self::Target
  Converts this mutable reference into a mutable reference to the other type.
  Parameters:
    - self: A mutable reference to the object.
  Returns:
    - A mutable reference to the target type.
```

```APIDOC
Clone Trait Implementation for SamplerCreateInfo:

clone(&self) -> SamplerCreateInfo
  Returns a duplicate of the value.
  Parameters:
    - self: A reference to the SamplerCreateInfo object.
  Returns:
    - A new SamplerCreateInfo object that is a copy of the original.

clone_from(&mut self, source: &Self)
  Performs copy-assignment from `source`.
  Parameters:
    - self: A mutable reference to the SamplerCreateInfo object to be updated.
    - source: A reference to the SamplerCreateInfo object to copy from.
```

```APIDOC
Debug Trait Implementation for SamplerCreateInfo:

fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>
  Formats the value using the given formatter.
  Parameters:
    - self: A reference to the SamplerCreateInfo object.
    - f: A mutable reference to the Formatter.
  Returns:
    - A Result indicating success or failure of the formatting operation.
```

```APIDOC
Default Trait Implementation for SamplerCreateInfo:

default() -> SamplerCreateInfo
  Returns the "default value" for a type.
  Returns:
    - A SamplerCreateInfo object initialized with default values.
```

```APIDOC
HasBuilder Trait Implementation for SamplerCreateInfo:

Builder Type Alias:
  type Builder = SamplerCreateInfoBuilder<'b>
    The associated builder for this type.

builder() -> Self::Builder
  Constructs an instance of the associated builder for this type.
  Returns:
    - An instance of SamplerCreateInfoBuilder.
```

```APIDOC
InputChainStruct Trait Implementation for SamplerCreateInfo:

TYPE Constant:
  This indicates that SamplerCreateInfo is part of the InputChainStruct mechanism, likely for managing Vulkan structures in a chain.
```

--------------------------------

### Rust: Generic Any Implementation

Source: https://docs.rs/vulkanalia/vulkanalia/vk/struct.SysmemColorSpaceFUCHSIA

A blanket implementation of the Any trait for any type T, providing a way to get the TypeId of a value.

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

--------------------------------

### vulkanalia Crate Overview

Source: https://docs.rs/vulkanalia/vulkanalia/vk/struct.DeviceQueueCreateFlags

Provides an overview of the vulkanalia crate, including its version, license, repository links, and dependencies. It also lists supported platforms and available feature flags.

```Rust
Project: /context7/rs-vulkanalia

vulkanalia-0.29.0

Dependencies:
- libloading ^0.8.5
- raw-window-handle ^0.6
- vulkanalia-sys ^0.29
- cocoa ^0.25 (optional)
- metal ^0.27 (optional)
- objc ^0.2 (optional)

Platforms:
- i686-pc-windows-msvc
- i686-unknown-linux-gnu
- x86_64-pc-windows-msvc
- x86_64-unknown-linux-gnu

License: Apache-2.0
Repository: https://github.com/KyleMayes/vulkanalia
```

--------------------------------

### Implement Any for T in Rust

Source: https://docs.rs/vulkanalia/vulkanalia/vk/struct.SubpassDependency

Provides a way to get the `TypeId` of any type `T` that implements `Any`. This is useful for runtime type introspection.

```rust
impl<T> Any for T where T: 'static + ?Sized
fn type_id(&self) -> TypeId
```

--------------------------------

### InstanceCreateInfoBuilder Methods (Rust)

Source: https://docs.rs/vulkanalia/vulkanalia/vk/struct.InstanceCreateInfoBuilder

Details the builder pattern methods for constructing Vulkan InstanceCreateInfo. Includes methods for setting flags, application info, enabled layers, and extensions, culminating in a build method.

```rust
pub fn push_next<T>(self, next: &'b mut impl Cast<Target = T>) -> Self where T: ExtendsInstanceCreateInfo,
```

```rust
pub fn flags(self, flags: InstanceCreateFlags) -> Self
```

```rust
pub fn application_info( self, application_info: &'b impl Cast<Target = ApplicationInfo>, ) -> Self
```

```rust
pub fn enabled_layer_names( self, enabled_layer_names: &[*const c_char], ) -> Self
```

```rust
pub fn enabled_extension_names( self, enabled_extension_names: &[*const c_char], ) -> Self
```

```rust
pub fn build(self) -> InstanceCreateInfo
```

--------------------------------

### Rust Any::type_id Method

Source: https://docs.rs/vulkanalia/vulkanalia/vk/struct.ShaderCreateInfoEXTBuilder

Gets the `TypeId` of `self`. This method is part of the `Any` trait and is used for runtime type identification.

```rust
fn type_id(&self) -> TypeId
```

--------------------------------

### Vulkan Entry Commands (Rust)

Source: https://docs.rs/vulkanalia/src/vulkanalia/vk/versions.rs

Provides Rust wrappers for Vulkan entry-point functions, enabling instance creation and enumeration of instance-level properties and layers. These wrappers simplify interaction with the Vulkan API by handling memory management and result checking.

```rust
/// Vulkan 1.0 entry command wrappers.
pub trait EntryV1_0 {
    fn commands(&self) -> &EntryCommands;

    /// <https://www.khronos.org/registry/vulkan/specs/latest/man/html/vkCreateInstance.html>
    #[inline]
    unsafe fn create_instance(
        &self,
        create_info: &InstanceCreateInfo,
        allocator: Option<&AllocationCallbacks>,
    ) -> crate::VkResult<Instance> {
        let mut instance = MaybeUninit::<Instance>::uninit();

        let __result = (self.commands().create_instance)(
            create_info,
            allocator.map_or(ptr::null(), |v| v),
            instance.as_mut_ptr(),
        );

        if __result == Result::SUCCESS {
            Ok(instance.assume_init())
        } else {
            Err(__result.into())
        }
    }

    /// <https://www.khronos.org/registry/vulkan/specs/latest/man/html/vkEnumerateInstanceExtensionProperties.html>
    #[inline]
    unsafe fn enumerate_instance_extension_properties(
        &self,
        layer_name: Option<&[u8]>,
    ) -> crate::VkResult<Vec<ExtensionProperties>> {
        let mut property_count = 0;

        (self.commands().enumerate_instance_extension_properties)(
            layer_name.map_or(ptr::null(), |v| v.as_ptr().cast()),
            &mut property_count,
            ptr::null_mut(),
        );

        let mut properties = Vec::with_capacity(property_count as usize);

        let __result = (self.commands().enumerate_instance_extension_properties)(
            layer_name.map_or(ptr::null(), |v| v.as_ptr().cast()),
            &mut property_count,
            properties.as_mut_ptr(),
        );

        debug_assert!(properties.capacity() == property_count as usize);
        properties.set_len(property_count as usize);

        if __result == Result::SUCCESS {
            Ok(properties)
        } else {
            Err(__result.into())
        }
    }

    /// <https://www.khronos.org/registry/vulkan/specs/latest/man/html/vkEnumerateInstanceLayerProperties.html>
    #[inline]
    unsafe fn enumerate_instance_layer_properties(&self) -> crate::VkResult<Vec<LayerProperties>> {
        let mut property_count = 0;

        (self.commands().enumerate_instance_layer_properties)(&mut property_count, ptr::null_mut());

        let mut properties = Vec::with_capacity(property_count as usize);

        let __result = (self.commands().enumerate_instance_layer_properties)(
            &mut property_count,
            properties.as_mut_ptr(),
        );

        debug_assert!(properties.capacity() == property_count as usize);
        properties.set_len(property_count as usize);

        if __result == Result::SUCCESS {
            Ok(properties)
        } else {
            Err(__result.into())
        }
    }
}

impl EntryV1_0 for crate::Entry {
    #[inline]
    fn commands(&self) -> &EntryCommands {
        &self.commands
    }
}
```

--------------------------------

### Get Default SemaphoreCreateInfoBuilder

Source: https://docs.rs/vulkanalia/vulkanalia/vk/struct.SemaphoreCreateInfoBuilder

Provides the default value for the SemaphoreCreateInfoBuilder type. This is useful for initializing the builder with standard settings.

```rust
fn default() -> SemaphoreCreateInfoBuilder<'b>
  Returns the “default value” for a type.
```

--------------------------------

### Vulkan Ray Tracing Commands

Source: https://docs.rs/vulkanalia/vulkanalia/vk/struct.DeviceCommands

This section covers Vulkan commands specifically related to ray tracing operations, including pipeline setup and ray generation.

```APIDOC
Vulkan Ray Tracing Commands:

  - vkCmdSetRayTracingPipelineStackSizeKHR
    - Description: Sets the stack size for ray tracing pipelines.

  - vkCmdTraceRaysIndirect2KHR
    - Description: Generates rays indirectly using a buffer for parameters.

  - vkCmdTraceRaysIndirectKHR
    - Description: Generates rays indirectly.

  - vkCmdTraceRaysKHR
    - Description: Generates rays directly.
    - Parameters: command buffer, acceleration structure, ray generation shader, dimensions, etc.
    - Usage: Used to dispatch ray tracing work.

```

--------------------------------

### Any Trait Implementation (Blanket)

Source: https://docs.rs/vulkanalia/vulkanalia/vk/struct.PhysicalDeviceRawAccessChainsFeaturesNV

Details the blanket implementation of the Any trait for generic types T, including a method to get the TypeId.

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

fn type_id(&self) -> TypeId
```

--------------------------------

### vulkanalia 0.29.0 Crate Overview

Source: https://docs.rs/vulkanalia/vulkanalia/prelude/v1_4/index

Provides an overview of the vulkanalia crate version 0.29.0, including links to its repository, crates.io page, source code, and license.

```APIDOC
Crate: vulkanalia
Version: 0.29.0
License: Apache-2.0
Repository: https://github.com/KyleMayes/vulkanalia
Crates.io: https://crates.io/crates/vulkanalia
Docs.rs: https://docs.rs/vulkanalia/0.29.0/vulkanalia/
```

--------------------------------

### Any trait implementation

Source: https://docs.rs/vulkanalia/vulkanalia/vk/struct.DebugUtilsMessengerCreateInfoEXTBuilder

Blanket implementation of the Any trait for any type T that is 'static and Sized. Provides a method to get the TypeId of the instance.

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

  fn type_id(&self) -> TypeId
```

--------------------------------

### ImageViewMinLodCreateInfoEXTBuilder Methods

Source: https://docs.rs/vulkanalia/vulkanalia/vk/struct.ImageViewMinLodCreateInfoEXTBuilder

Provides methods for configuring and building an ImageViewMinLodCreateInfoEXT structure. Includes setting the minimum LOD and the final build operation.

```rust
pub fn min_lod(self, min_lod: f32) -> Self
// Sets the minimum level of detail for the image view.

pub fn build(self) -> ImageViewMinLodCreateInfoEXT
// Builds the ImageViewMinLodCreateInfoEXT structure from the builder.
```

--------------------------------

### Get Default ClearAttachmentBuilder

Source: https://docs.rs/vulkanalia/vulkanalia/vk/struct.ClearAttachmentBuilder

Provides the default value for the ClearAttachmentBuilder type, useful for initializing builders.

```rust
fn default() -> ClearAttachmentBuilder
```

--------------------------------

### Vulkanalia Quick Tip

Source: https://docs.rs/vulkanalia/vulkanalia/index

A tip for developers using the vulkanalia crate regarding the usage of builder structs.

```rust
/// 1. Use builder structs, but don’t `build` them unless you need to!
```
Tokens:
Raw