Vulkan.Extensions.VK_NVX_image_view_handle

Name

VK_NVX_image_view_handle - device extension

VK_NVX_image_view_handle

Name String

VK_NVX_image_view_handle

Extension Type

Device extension

Registered Extension Number

31

Revision

2

Extension and Version Dependencies

• Requires support for Vulkan 1.0

Contact

• Eric Werness @ewerness-nv%0A*Here describe the issue or question you have about the VK_NVX_image_view_handle extension*

Other Extension Metadata

Last Modified Date

2020-04-03

Contributors

• Eric Werness, NVIDIA
• Jeff Bolz, NVIDIA
• Daniel Koch, NVIDIA

Description

This extension allows applications to query an opaque handle from an image view for use as a sampled image or storage image. This provides no direct functionality itself.

New Commands

• getImageViewAddressNVX

• getImageViewHandleNVX

New Structures

• ImageViewAddressPropertiesNVX

• ImageViewHandleInfoNVX

New Enum Constants

• NVX_IMAGE_VIEW_HANDLE_EXTENSION_NAME

• NVX_IMAGE_VIEW_HANDLE_SPEC_VERSION

• Extending StructureType:

  • STRUCTURE_TYPE_IMAGE_VIEW_ADDRESS_PROPERTIES_NVX
  • STRUCTURE_TYPE_IMAGE_VIEW_HANDLE_INFO_NVX

Version History

• Revision 2, 2020-04-03 (Piers Daniell)

  • Add getImageViewAddressNVX

• Revision 1, 2018-12-07 (Eric Werness)

  • Internal revisions

See Also

ImageViewAddressPropertiesNVX, ImageViewHandleInfoNVX, getImageViewAddressNVX, getImageViewHandleNVX

Document Notes

For more information, see the Vulkan Specification

This page is a generated document. Fixes and changes should be made to the generator scripts, not directly.

Documentation

getImageViewHandleNVX

Arguments

:: forall io. MonadIO io

=> Device

device is the logical device that owns the image view.

device must be a valid Device handle

-> ImageViewHandleInfoNVX

pInfo describes the image view to query and type of handle.

pInfo must be a valid pointer to a valid ImageViewHandleInfoNVX structure

-> io Word32

vkGetImageViewHandleNVX - Get the handle for an image view for a specific descriptor type

Valid Usage (Implicit)

See Also

VK_NVX_image_view_handle, Device, ImageViewHandleInfoNVX

getImageViewAddressNVX

Arguments

:: forall io. MonadIO io

=> Device

device is the logical device that owns the image view.

device must be a valid Device handle

-> ImageView

imageView is a handle to the image view.

imageView must be a valid ImageView handle

imageView must have been created, allocated, or retrieved from device

-> io ImageViewAddressPropertiesNVX

vkGetImageViewAddressNVX - Get the device address of an image view

Return Codes

Success

• SUCCESS

Failure

• ERROR_OUT_OF_HOST_MEMORY
• ERROR_UNKNOWN

See Also

VK_NVX_image_view_handle, Device, ImageView, ImageViewAddressPropertiesNVX

data ImageViewHandleInfoNVX

VkImageViewHandleInfoNVX - Structure specifying the image view for handle queries

Valid Usage

• descriptorType must be DESCRIPTOR_TYPE_SAMPLED_IMAGE, DESCRIPTOR_TYPE_STORAGE_IMAGE, or DESCRIPTOR_TYPE_COMBINED_IMAGE_SAMPLER

• sampler must be a valid Sampler if descriptorType is DESCRIPTOR_TYPE_COMBINED_IMAGE_SAMPLER
• If descriptorType is DESCRIPTOR_TYPE_SAMPLED_IMAGE or DESCRIPTOR_TYPE_COMBINED_IMAGE_SAMPLER, the image that imageView was created from must have been created with the IMAGE_USAGE_SAMPLED_BIT usage bit set
• If descriptorType is DESCRIPTOR_TYPE_STORAGE_IMAGE, the image that imageView was created from must have been created with the IMAGE_USAGE_STORAGE_BIT usage bit set

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_IMAGE_VIEW_HANDLE_INFO_NVX

• pNext must be NULL
• imageView must be a valid ImageView handle
• descriptorType must be a valid DescriptorType value
• If sampler is not NULL_HANDLE, sampler must be a valid Sampler handle
• Both of imageView, and sampler that are valid handles of non-ignored parameters must have been created, allocated, or retrieved from the same Device

See Also

VK_NVX_image_view_handle, DescriptorType, ImageView, Sampler, StructureType, getImageViewHandleNVX

Constructors

ImageViewHandleInfoNVX

Fields

• imageView :: ImageView

  imageView is the image view to query.

• descriptorType :: DescriptorType

  descriptorType is the type of descriptor for which to query a handle.

• sampler :: Sampler

  sampler is the sampler to combine with the image view when generating the handle.

Instances

Storable ImageViewHandleInfoNVX

Defined in Vulkan.Extensions.VK_NVX_image_view_handle

Methods

sizeOf :: ImageViewHandleInfoNVX -> Int

alignment :: ImageViewHandleInfoNVX -> Int

peekElemOff :: Ptr ImageViewHandleInfoNVX -> Int -> IO ImageViewHandleInfoNVX

pokeElemOff :: Ptr ImageViewHandleInfoNVX -> Int -> ImageViewHandleInfoNVX -> IO ()

peekByteOff :: Ptr b -> Int -> IO ImageViewHandleInfoNVX

pokeByteOff :: Ptr b -> Int -> ImageViewHandleInfoNVX -> IO ()

peek :: Ptr ImageViewHandleInfoNVX -> IO ImageViewHandleInfoNVX

poke :: Ptr ImageViewHandleInfoNVX -> ImageViewHandleInfoNVX -> IO ()

Show ImageViewHandleInfoNVX

Defined in Vulkan.Extensions.VK_NVX_image_view_handle

Methods

showsPrec :: Int -> ImageViewHandleInfoNVX -> ShowS

show :: ImageViewHandleInfoNVX -> String

showList :: [ImageViewHandleInfoNVX] -> ShowS

Eq ImageViewHandleInfoNVX

Defined in Vulkan.Extensions.VK_NVX_image_view_handle

Methods

(==) :: ImageViewHandleInfoNVX -> ImageViewHandleInfoNVX -> Bool

(/=) :: ImageViewHandleInfoNVX -> ImageViewHandleInfoNVX -> Bool

FromCStruct ImageViewHandleInfoNVX

Defined in Vulkan.Extensions.VK_NVX_image_view_handle

Methods

peekCStruct :: Ptr ImageViewHandleInfoNVX -> IO ImageViewHandleInfoNVX

ToCStruct ImageViewHandleInfoNVX

Defined in Vulkan.Extensions.VK_NVX_image_view_handle

Methods

withCStruct :: ImageViewHandleInfoNVX -> (Ptr ImageViewHandleInfoNVX -> IO b) -> IO b

pokeCStruct :: Ptr ImageViewHandleInfoNVX -> ImageViewHandleInfoNVX -> IO b -> IO b

withZeroCStruct :: (Ptr ImageViewHandleInfoNVX -> IO b) -> IO b

pokeZeroCStruct :: Ptr ImageViewHandleInfoNVX -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

Zero ImageViewHandleInfoNVX

Defined in Vulkan.Extensions.VK_NVX_image_view_handle

Methods

zero :: ImageViewHandleInfoNVX

data ImageViewAddressPropertiesNVX

VkImageViewAddressPropertiesNVX - Structure specifying the image view for handle queries

Valid Usage (Implicit)

See Also

VK_NVX_image_view_handle, DeviceAddress, DeviceSize, StructureType, getImageViewAddressNVX

Constructors

ImageViewAddressPropertiesNVX

Fields

• deviceAddress :: DeviceAddress

  deviceAddress is the device address of the image view.

• size :: DeviceSize

  size is the size in bytes of the image view device memory.

Instances

Storable ImageViewAddressPropertiesNVX

Defined in Vulkan.Extensions.VK_NVX_image_view_handle

Methods

sizeOf :: ImageViewAddressPropertiesNVX -> Int

alignment :: ImageViewAddressPropertiesNVX -> Int

peekElemOff :: Ptr ImageViewAddressPropertiesNVX -> Int -> IO ImageViewAddressPropertiesNVX

pokeElemOff :: Ptr ImageViewAddressPropertiesNVX -> Int -> ImageViewAddressPropertiesNVX -> IO ()

peekByteOff :: Ptr b -> Int -> IO ImageViewAddressPropertiesNVX

pokeByteOff :: Ptr b -> Int -> ImageViewAddressPropertiesNVX -> IO ()

peek :: Ptr ImageViewAddressPropertiesNVX -> IO ImageViewAddressPropertiesNVX

poke :: Ptr ImageViewAddressPropertiesNVX -> ImageViewAddressPropertiesNVX -> IO ()

Show ImageViewAddressPropertiesNVX

Defined in Vulkan.Extensions.VK_NVX_image_view_handle

Methods

showsPrec :: Int -> ImageViewAddressPropertiesNVX -> ShowS

show :: ImageViewAddressPropertiesNVX -> String

showList :: [ImageViewAddressPropertiesNVX] -> ShowS

Eq ImageViewAddressPropertiesNVX

Defined in Vulkan.Extensions.VK_NVX_image_view_handle

Methods

(==) :: ImageViewAddressPropertiesNVX -> ImageViewAddressPropertiesNVX -> Bool

(/=) :: ImageViewAddressPropertiesNVX -> ImageViewAddressPropertiesNVX -> Bool

FromCStruct ImageViewAddressPropertiesNVX

Defined in Vulkan.Extensions.VK_NVX_image_view_handle

Methods

peekCStruct :: Ptr ImageViewAddressPropertiesNVX -> IO ImageViewAddressPropertiesNVX

ToCStruct ImageViewAddressPropertiesNVX

Defined in Vulkan.Extensions.VK_NVX_image_view_handle

Methods

withCStruct :: ImageViewAddressPropertiesNVX -> (Ptr ImageViewAddressPropertiesNVX -> IO b) -> IO b

pokeCStruct :: Ptr ImageViewAddressPropertiesNVX -> ImageViewAddressPropertiesNVX -> IO b -> IO b

withZeroCStruct :: (Ptr ImageViewAddressPropertiesNVX -> IO b) -> IO b

pokeZeroCStruct :: Ptr ImageViewAddressPropertiesNVX -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

Zero ImageViewAddressPropertiesNVX

Defined in Vulkan.Extensions.VK_NVX_image_view_handle

Methods

zero :: ImageViewAddressPropertiesNVX

type NVX_IMAGE_VIEW_HANDLE_SPEC_VERSION = 2

pattern NVX_IMAGE_VIEW_HANDLE_SPEC_VERSION :: forall a. Integral a => a

type NVX_IMAGE_VIEW_HANDLE_EXTENSION_NAME = "VK_NVX_image_view_handle"

pattern NVX_IMAGE_VIEW_HANDLE_EXTENSION_NAME :: forall a. (Eq a, IsString a) => a