Vulkan.Core10.BufferView

Documentation

createBufferView

Arguments

:: forall io. MonadIO io

=> Device

device is the logical device that creates the buffer view.

-> BufferViewCreateInfo

pCreateInfo is a pointer to a BufferViewCreateInfo structure containing parameters to be used to create the buffer.

-> ("allocator" ::: Maybe AllocationCallbacks)

pAllocator controls host memory allocation as described in the Memory Allocation chapter.

-> io BufferView

vkCreateBufferView - Create a new buffer view object

Valid Usage (Implicit)

• device must be a valid Device handle

• pCreateInfo must be a valid pointer to a valid BufferViewCreateInfo structure
• If pAllocator is not NULL, pAllocator must be a valid pointer to a valid AllocationCallbacks structure
• pView must be a valid pointer to a BufferView handle

Return Codes

Success

• SUCCESS

Failure

• ERROR_OUT_OF_HOST_MEMORY
• ERROR_OUT_OF_DEVICE_MEMORY

See Also

AllocationCallbacks, BufferView, BufferViewCreateInfo, Device

withBufferView :: forall io r. MonadIO io => Device -> BufferViewCreateInfo -> Maybe AllocationCallbacks -> (io BufferView -> (BufferView -> io ()) -> r) -> r

A convenience wrapper to make a compatible pair of calls to createBufferView and destroyBufferView

To ensure that destroyBufferView is always called: pass bracket (or the allocate function from your favourite resource management library) as the first argument. To just extract the pair pass (,) as the first argument.

destroyBufferView

Arguments

:: forall io. MonadIO io

=> Device

device is the logical device that destroys the buffer view.

-> BufferView

bufferView is the buffer view to destroy.

-> ("allocator" ::: Maybe AllocationCallbacks)

pAllocator controls host memory allocation as described in the Memory Allocation chapter.

-> io ()

vkDestroyBufferView - Destroy a buffer view object

Valid Usage

• All submitted commands that refer to bufferView must have completed execution

• If AllocationCallbacks were provided when bufferView was created, a compatible set of callbacks must be provided here
• If no AllocationCallbacks were provided when bufferView was created, pAllocator must be NULL

Valid Usage (Implicit)

• device must be a valid Device handle

• If bufferView is not NULL_HANDLE, bufferView must be a valid BufferView handle
• If pAllocator is not NULL, pAllocator must be a valid pointer to a valid AllocationCallbacks structure
• If bufferView is a valid handle, it must have been created, allocated, or retrieved from device

Host Synchronization

• Host access to bufferView must be externally synchronized

See Also

AllocationCallbacks, BufferView, Device

data BufferViewCreateInfo

VkBufferViewCreateInfo - Structure specifying parameters of a newly created buffer view

Valid Usage

• offset must be less than the size of buffer

• If range is not equal to WHOLE_SIZE, range must be greater than 0
• If range is not equal to WHOLE_SIZE, range must be an integer multiple of the texel block size of format
• If range is not equal to WHOLE_SIZE, the number of texel buffer elements given by (⌊range / (texel block size)⌋ × (texels per block)) where texel block size and texels per block are as defined in the Compatible Formats table for format, must be less than or equal to PhysicalDeviceLimits::maxTexelBufferElements
• If range is not equal to WHOLE_SIZE, the sum of offset and range must be less than or equal to the size of buffer
• If range is equal to WHOLE_SIZE, the number of texel buffer elements given by (⌊(size - offset) / (texel block size)⌋ × (texels per block)) where size is the size of buffer, and texel block size and texels per block are as defined in the Compatible Formats table for format, must be less than or equal to PhysicalDeviceLimits::maxTexelBufferElements
• buffer must have been created with a usage value containing at least one of BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT or BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT
• If buffer was created with usage containing BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT, format must be supported for uniform texel buffers, as specified by the FORMAT_FEATURE_UNIFORM_TEXEL_BUFFER_BIT flag in FormatProperties::bufferFeatures returned by getPhysicalDeviceFormatProperties
• If buffer was created with usage containing BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT, format must be supported for storage texel buffers, as specified by the FORMAT_FEATURE_STORAGE_TEXEL_BUFFER_BIT flag in FormatProperties::bufferFeatures returned by getPhysicalDeviceFormatProperties
• If buffer is non-sparse then it must be bound completely and contiguously to a single DeviceMemory object
• If the texelBufferAlignment feature is not enabled, offset must be a multiple of PhysicalDeviceLimits::minTexelBufferOffsetAlignment
• If the texelBufferAlignment feature is enabled and if buffer was created with usage containing BUFFER_USAGE_STORAGE_TEXEL_BUFFER_BIT, offset must be a multiple of the lesser of PhysicalDeviceTexelBufferAlignmentPropertiesEXT::storageTexelBufferOffsetAlignmentBytes or, if PhysicalDeviceTexelBufferAlignmentPropertiesEXT::storageTexelBufferOffsetSingleTexelAlignment is TRUE, the size of a texel of the requested format. If the size of a texel is a multiple of three bytes, then the size of a single component of format is used instead
• If the texelBufferAlignment feature is enabled and if buffer was created with usage containing BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT, offset must be a multiple of the lesser of PhysicalDeviceTexelBufferAlignmentPropertiesEXT::uniformTexelBufferOffsetAlignmentBytes or, if PhysicalDeviceTexelBufferAlignmentPropertiesEXT::uniformTexelBufferOffsetSingleTexelAlignment is TRUE, the size of a texel of the requested format. If the size of a texel is a multiple of three bytes, then the size of a single component of format is used instead

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_BUFFER_VIEW_CREATE_INFO

• pNext must be NULL
• flags must be 0
• buffer must be a valid Buffer handle
• format must be a valid Format value

See Also

Buffer, BufferViewCreateFlags, DeviceSize, Format, StructureType, createBufferView

Constructors

BufferViewCreateInfo

Fields

• flags :: BufferViewCreateFlags

  flags is reserved for future use.

• buffer :: Buffer

  buffer is a Buffer on which the view will be created.

• format :: Format

  format is a Format describing the format of the data elements in the buffer.

• offset :: DeviceSize

  offset is an offset in bytes from the base address of the buffer. Accesses to the buffer view from shaders use addressing that is relative to this starting offset.

• range :: DeviceSize

  range is a size in bytes of the buffer view. If range is equal to WHOLE_SIZE, the range from offset to the end of the buffer is used. If WHOLE_SIZE is used and the remaining size of the buffer is not a multiple of the texel block size of format, the nearest smaller multiple is used.

Instances

Eq BufferViewCreateInfo

Defined in Vulkan.Core10.BufferView

Methods

(==) :: BufferViewCreateInfo -> BufferViewCreateInfo -> Bool

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

Show BufferViewCreateInfo

Defined in Vulkan.Core10.BufferView

Methods

showsPrec :: Int -> BufferViewCreateInfo -> ShowS

show :: BufferViewCreateInfo -> String

showList :: [BufferViewCreateInfo] -> ShowS

Generic BufferViewCreateInfo

Defined in Vulkan.Core10.BufferView

Associated Types

type Rep BufferViewCreateInfo :: Type -> Type

Methods

from :: BufferViewCreateInfo -> Rep BufferViewCreateInfo x

to :: Rep BufferViewCreateInfo x -> BufferViewCreateInfo

Storable BufferViewCreateInfo

Defined in Vulkan.Core10.BufferView

Methods

sizeOf :: BufferViewCreateInfo -> Int

alignment :: BufferViewCreateInfo -> Int

peekElemOff :: Ptr BufferViewCreateInfo -> Int -> IO BufferViewCreateInfo

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

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

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

peek :: Ptr BufferViewCreateInfo -> IO BufferViewCreateInfo

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

FromCStruct BufferViewCreateInfo

Defined in Vulkan.Core10.BufferView

Methods

peekCStruct :: Ptr BufferViewCreateInfo -> IO BufferViewCreateInfo

ToCStruct BufferViewCreateInfo

Defined in Vulkan.Core10.BufferView

Methods

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

pokeCStruct :: Ptr BufferViewCreateInfo -> BufferViewCreateInfo -> IO b -> IO b

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

pokeZeroCStruct :: Ptr BufferViewCreateInfo -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

Zero BufferViewCreateInfo

Defined in Vulkan.Core10.BufferView

Methods

zero :: BufferViewCreateInfo

type Rep BufferViewCreateInfo

Defined in Vulkan.Core10.BufferView

type Rep BufferViewCreateInfo = D1 ('MetaData "BufferViewCreateInfo" "Vulkan.Core10.BufferView" "vulkan-3.5-inplace" 'False) (C1 ('MetaCons "BufferViewCreateInfo" 'PrefixI 'True) ((S1 ('MetaSel ('Just "flags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 BufferViewCreateFlags) :*: S1 ('MetaSel ('Just "buffer") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Buffer)) :*: (S1 ('MetaSel ('Just "format") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Format) :*: (S1 ('MetaSel ('Just "offset") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 DeviceSize) :*: S1 ('MetaSel ('Just "range") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 DeviceSize)))))

newtype BufferView

VkBufferView - Opaque handle to a buffer view object

See Also

WriteDescriptorSet, createBufferView, destroyBufferView

Constructors

BufferView Word64

Instances

Eq BufferView

Defined in Vulkan.Core10.Handles

Methods

(==) :: BufferView -> BufferView -> Bool

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

Ord BufferView

Defined in Vulkan.Core10.Handles

Methods

compare :: BufferView -> BufferView -> Ordering

(<) :: BufferView -> BufferView -> Bool

(<=) :: BufferView -> BufferView -> Bool

(>) :: BufferView -> BufferView -> Bool

(>=) :: BufferView -> BufferView -> Bool

max :: BufferView -> BufferView -> BufferView

min :: BufferView -> BufferView -> BufferView

Show BufferView

Defined in Vulkan.Core10.Handles

Methods

showsPrec :: Int -> BufferView -> ShowS

show :: BufferView -> String

showList :: [BufferView] -> ShowS

Storable BufferView

Defined in Vulkan.Core10.Handles

Methods

sizeOf :: BufferView -> Int

alignment :: BufferView -> Int

peekElemOff :: Ptr BufferView -> Int -> IO BufferView

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

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

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

peek :: Ptr BufferView -> IO BufferView

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

Zero BufferView

Defined in Vulkan.Core10.Handles

Methods

zero :: BufferView

HasObjectType BufferView

Defined in Vulkan.Core10.Handles

Methods

objectTypeAndHandle :: BufferView -> (ObjectType, Word64)

IsHandle BufferView

Defined in Vulkan.Core10.Handles

newtype BufferViewCreateFlags

VkBufferViewCreateFlags - Reserved for future use

Description

BufferViewCreateFlags is a bitmask type for setting a mask, but is currently reserved for future use.

See Also

BufferViewCreateInfo

Constructors

BufferViewCreateFlags Flags

Instances

Eq BufferViewCreateFlags

Defined in Vulkan.Core10.Enums.BufferViewCreateFlags

Methods

(==) :: BufferViewCreateFlags -> BufferViewCreateFlags -> Bool

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

Ord BufferViewCreateFlags

Defined in Vulkan.Core10.Enums.BufferViewCreateFlags

Methods

compare :: BufferViewCreateFlags -> BufferViewCreateFlags -> Ordering

(<) :: BufferViewCreateFlags -> BufferViewCreateFlags -> Bool

(<=) :: BufferViewCreateFlags -> BufferViewCreateFlags -> Bool

(>) :: BufferViewCreateFlags -> BufferViewCreateFlags -> Bool

(>=) :: BufferViewCreateFlags -> BufferViewCreateFlags -> Bool

max :: BufferViewCreateFlags -> BufferViewCreateFlags -> BufferViewCreateFlags

min :: BufferViewCreateFlags -> BufferViewCreateFlags -> BufferViewCreateFlags

Read BufferViewCreateFlags

Defined in Vulkan.Core10.Enums.BufferViewCreateFlags

Methods

readsPrec :: Int -> ReadS BufferViewCreateFlags

readList :: ReadS [BufferViewCreateFlags]

readPrec :: ReadPrec BufferViewCreateFlags

readListPrec :: ReadPrec [BufferViewCreateFlags]

Show BufferViewCreateFlags

Defined in Vulkan.Core10.Enums.BufferViewCreateFlags

Methods

showsPrec :: Int -> BufferViewCreateFlags -> ShowS

show :: BufferViewCreateFlags -> String

showList :: [BufferViewCreateFlags] -> ShowS

Storable BufferViewCreateFlags

Defined in Vulkan.Core10.Enums.BufferViewCreateFlags

Methods

sizeOf :: BufferViewCreateFlags -> Int

alignment :: BufferViewCreateFlags -> Int

peekElemOff :: Ptr BufferViewCreateFlags -> Int -> IO BufferViewCreateFlags

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

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

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

peek :: Ptr BufferViewCreateFlags -> IO BufferViewCreateFlags

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

Bits BufferViewCreateFlags

Defined in Vulkan.Core10.Enums.BufferViewCreateFlags

Methods

(.&.) :: BufferViewCreateFlags -> BufferViewCreateFlags -> BufferViewCreateFlags

(.|.) :: BufferViewCreateFlags -> BufferViewCreateFlags -> BufferViewCreateFlags

xor :: BufferViewCreateFlags -> BufferViewCreateFlags -> BufferViewCreateFlags

complement :: BufferViewCreateFlags -> BufferViewCreateFlags

shift :: BufferViewCreateFlags -> Int -> BufferViewCreateFlags

rotate :: BufferViewCreateFlags -> Int -> BufferViewCreateFlags

zeroBits :: BufferViewCreateFlags

bit :: Int -> BufferViewCreateFlags

setBit :: BufferViewCreateFlags -> Int -> BufferViewCreateFlags

clearBit :: BufferViewCreateFlags -> Int -> BufferViewCreateFlags

complementBit :: BufferViewCreateFlags -> Int -> BufferViewCreateFlags

testBit :: BufferViewCreateFlags -> Int -> Bool

bitSizeMaybe :: BufferViewCreateFlags -> Maybe Int

bitSize :: BufferViewCreateFlags -> Int

isSigned :: BufferViewCreateFlags -> Bool

shiftL :: BufferViewCreateFlags -> Int -> BufferViewCreateFlags

unsafeShiftL :: BufferViewCreateFlags -> Int -> BufferViewCreateFlags

shiftR :: BufferViewCreateFlags -> Int -> BufferViewCreateFlags

unsafeShiftR :: BufferViewCreateFlags -> Int -> BufferViewCreateFlags

rotateL :: BufferViewCreateFlags -> Int -> BufferViewCreateFlags

rotateR :: BufferViewCreateFlags -> Int -> BufferViewCreateFlags

popCount :: BufferViewCreateFlags -> Int

Zero BufferViewCreateFlags

Defined in Vulkan.Core10.Enums.BufferViewCreateFlags

Methods

zero :: BufferViewCreateFlags