Trait VkObject

pub trait VkObject: VkHandle {
    const TYPE: VkObjectType;

    // Provided method
    fn set_name(&self, name: Option<&CStr>) -> Result<()>
       where Self: DeviceChild<ConcreteDevice: InstanceChild<ConcreteInstance: InstanceExtensions>>,
             Self::Handle: VkRawHandle { ... }
}

An object in Vulkan

Required Associated Constants

const TYPE: VkObjectType

Provided Methods

fn set_name(&self, name: Option<&CStr>) -> Result<()>

where Self: DeviceChild<ConcreteDevice: InstanceChild<ConcreteInstance: InstanceExtensions>>, Self::Handle: VkRawHandle,

Available on crate features Implements and VK_EXT_debug_utils only.

Give a user-friendly name to this object.

Failures

On failure, this command returns

• VK_ERROR_OUT_OF_HOST_MEMORY
• VK_ERROR_OUT_OF_DEVICE_MEMORY

Dyn Compatibility

This trait is not dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety", so this trait is not object safe.

Implementations on Foreign Types

impl<T: VkObject + ?Sized> VkObject for &T

const TYPE: VkObjectType = T::TYPE

impl<T: VkObject + ?Sized> VkObject for &mut T

const TYPE: VkObjectType = T::TYPE

impl<T: VkObject + ?Sized> VkObject for Rc<T>

const TYPE: VkObjectType = T::TYPE

impl<T: VkObject + ?Sized> VkObject for Arc<T>

const TYPE: VkObjectType = T::TYPE

impl<T: VkObject + ?Sized> VkObject for Ref<'_, T>

const TYPE: VkObjectType = T::TYPE

impl<T: VkObject + ?Sized> VkObject for RefMut<'_, T>

const TYPE: VkObjectType = T::TYPE

impl<T: VkObject + ?Sized> VkObject for MutexGuard<'_, T>

const TYPE: VkObjectType = T::TYPE

Implementors

impl VkObject for DisplayMode

Available on crate feature VK_KHR_display only.

const TYPE: VkObjectType = 1_000_002_001i32

impl VkObject for InstanceObject

const TYPE: VkObjectType = 1i32

impl<'r, Device: VkHandle<Handle = VkDevice>> VkObject for FramebufferObject<'r, Device>

const TYPE: VkObjectType = 24i32

impl<Buffer: DeviceChildHandle> VkObject for BufferViewObject<Buffer>

const TYPE: VkObjectType = 13i32

impl<Device> VkObject for CommandBufferObject<Device>

const TYPE: VkObjectType = 6i32

impl<Device> VkObject for QueueObject<Device>

const TYPE: VkObjectType = 4i32

impl<Device: Device> VkObject for DescriptorUpdateTemplateObject<Device>

Available on crate feature VK_KHR_descriptor_update_template only.

const TYPE: VkObjectType = 1_000_085_000i32

impl<Device: VkHandle<Handle = VkDevice>> VkObject for BufferObject<Device>

const TYPE: VkObjectType = 9i32

impl<Device: VkHandle<Handle = VkDevice>> VkObject for DeviceMemoryObject<Device>

const TYPE: VkObjectType = 8i32

impl<Device: VkHandle<Handle = VkDevice>> VkObject for ImageObject<Device>

const TYPE: VkObjectType = 10i32

impl<Device: VkHandle<Handle = VkDevice>> VkObject for SamplerObject<Device>

const TYPE: VkObjectType = 21i32

impl<Device: VkHandle<Handle = VkDevice>> VkObject for CommandPoolObject<Device>

const TYPE: VkObjectType = 25i32

impl<Device: VkHandle<Handle = VkDevice>> VkObject for DescriptorPoolObject<Device>

const TYPE: VkObjectType = 22i32

impl<Device: VkHandle<Handle = VkDevice>> VkObject for DescriptorSetLayoutObject<Device>

const TYPE: VkObjectType = 20i32

impl<Device: VkHandle<Handle = VkDevice>> VkObject for EventObject<Device>

const TYPE: VkObjectType = 11i32

impl<Device: VkHandle<Handle = VkDevice>> VkObject for FenceObject<Device>

const TYPE: VkObjectType = 7i32

impl<Device: VkHandle<Handle = VkDevice>> VkObject for PipelineCacheObject<Device>

const TYPE: VkObjectType = 16i32

impl<Device: VkHandle<Handle = VkDevice>> VkObject for PipelineLayoutObject<Device>

const TYPE: VkObjectType = 17i32

impl<Device: VkHandle<Handle = VkDevice>> VkObject for PipelineObject<Device>

const TYPE: VkObjectType = 19i32

impl<Device: VkHandle<Handle = VkDevice>> VkObject for QueryPoolObject<Device>

const TYPE: VkObjectType = 12i32

impl<Device: VkHandle<Handle = VkDevice>> VkObject for RenderPassObject<Device>

const TYPE: VkObjectType = 18i32

impl<Device: VkHandle<Handle = VkDevice>> VkObject for SemaphoreObject<Device>

const TYPE: VkObjectType = 5i32

impl<Device: VkHandle<Handle = VkDevice>> VkObject for ShaderModuleObject<Device>

const TYPE: VkObjectType = 15i32

impl<Device: VkHandle<Handle = VkDevice>, Surface: VkHandle<Handle = VkSurfaceKHR>> VkObject for SurfaceSwapchainObject<Device, Surface>

const TYPE: VkObjectType = 1_000_001_000i32

impl<Image: DeviceChildHandle> VkObject for ImageViewObject<Image>

const TYPE: VkObjectType = 14i32

impl<Instance> VkObject for DeviceObject<Instance>

const TYPE: VkObjectType = 3i32

impl<Instance: Instance + InstanceExtensions> VkObject for DebugReportCallbackObject<Instance>

Available on crate feature VK_EXT_debug_report only.

const TYPE: VkObjectType = 1_000_011_000i32

impl<Instance: Instance + InstanceExtensions> VkObject for DebugUtilsMessengerObject<Instance>

Available on crate feature VK_EXT_debug_utils only.

const TYPE: VkObjectType = 1_000_128_000i32

impl<Instance: Instance> VkObject for SurfaceObject<Instance>

const TYPE: VkObjectType = 1_000_000_000i32

impl<Owner: Instance> VkObject for PhysicalDeviceObject<Owner>

const TYPE: VkObjectType = 2i32

impl<PhysicalDevice: PhysicalDevice> VkObject for Display<PhysicalDevice>

Available on crate feature VK_KHR_display only.

const TYPE: VkObjectType = 1_000_002_000i32

impl<Swapchain> VkObject for SwapchainImage<Swapchain>

const TYPE: VkObjectType = 10i32