Skip to main content

VkResult

Type Alias VkResult 

Source
pub type VkResult<T> = Result<T, Result>;
Expand description

Vulkan API result type.

The Err variant is any negative vk::Result (an error code). Non-negative codes (including SUCCESS, INCOMPLETE, SUBOPTIMAL) are treated as success.

§Examples

use vulkan_rust::VkResult;
use vulkan_rust::vk;

fn do_vulkan_work() -> VkResult<u32> {
    // Simulate a successful Vulkan call.
    Ok(42)
}

let result = do_vulkan_work();
assert!(result.is_ok());

Aliased Type§

pub enum VkResult<T> {
    Ok(T),
    Err(Result),
}

Variants§

§1.0.0

Ok(T)

Contains the success value

§1.0.0

Err(Result)

Contains the error value