Safe Haskell | None |
---|---|
Language | Haskell2010 |
Synopsis
- data Offset2D = Offset2D {}
- data Offset3D = Offset3D {}
- data Extent2D = Extent2D {}
- data Extent3D = Extent3D {}
- data ImageSubresourceLayers = ImageSubresourceLayers {}
- data ImageSubresourceRange = ImageSubresourceRange {}
- data ClearDepthStencilValue = ClearDepthStencilValue {}
- data ClearColorValue
- data ClearValue
Documentation
VkOffset2D - Structure specifying a two-dimensional offset
See Also
Instances
Show Offset2D Source # | |
Storable Offset2D Source # | |
Defined in Graphics.Vulkan.Core10.SharedTypes | |
FromCStruct Offset2D Source # | |
Defined in Graphics.Vulkan.Core10.SharedTypes | |
ToCStruct Offset2D Source # | |
Defined in Graphics.Vulkan.Core10.SharedTypes | |
Zero Offset2D Source # | |
Defined in Graphics.Vulkan.Core10.SharedTypes |
VkOffset3D - Structure specifying a three-dimensional offset
See Also
BufferImageCopy
,
ImageBlit
,
ImageCopy
,
ImageResolve
,
SparseImageMemoryBind
Instances
Show Offset3D Source # | |
Storable Offset3D Source # | |
Defined in Graphics.Vulkan.Core10.SharedTypes | |
FromCStruct Offset3D Source # | |
Defined in Graphics.Vulkan.Core10.SharedTypes | |
ToCStruct Offset3D Source # | |
Defined in Graphics.Vulkan.Core10.SharedTypes | |
Zero Offset3D Source # | |
Defined in Graphics.Vulkan.Core10.SharedTypes |
VkExtent2D - Structure specifying a two-dimensional extent
See Also
DisplayModeParametersKHR
,
DisplayPlaneCapabilitiesKHR
,
DisplayPropertiesKHR
,
DisplaySurfaceCreateInfoKHR
,
MultisamplePropertiesEXT
,
PhysicalDeviceFragmentDensityMapPropertiesEXT
,
PhysicalDeviceSampleLocationsPropertiesEXT
,
PhysicalDeviceShadingRateImagePropertiesNV
,
Rect2D
,
RectLayerKHR
,
SampleLocationsInfoEXT
,
SurfaceCapabilities2EXT
,
SurfaceCapabilitiesKHR
,
SwapchainCreateInfoKHR
,
getRenderAreaGranularity
Instances
Show Extent2D Source # | |
Storable Extent2D Source # | |
Defined in Graphics.Vulkan.Core10.SharedTypes | |
FromCStruct Extent2D Source # | |
Defined in Graphics.Vulkan.Core10.SharedTypes | |
ToCStruct Extent2D Source # | |
Defined in Graphics.Vulkan.Core10.SharedTypes | |
Zero Extent2D Source # | |
Defined in Graphics.Vulkan.Core10.SharedTypes |
VkExtent3D - Structure specifying a three-dimensional extent
See Also
BufferImageCopy
,
ImageCopy
,
ImageCreateInfo
,
ImageFormatProperties
,
ImageResolve
,
QueueFamilyProperties
,
SparseImageFormatProperties
,
SparseImageMemoryBind
Instances
Show Extent3D Source # | |
Storable Extent3D Source # | |
Defined in Graphics.Vulkan.Core10.SharedTypes | |
FromCStruct Extent3D Source # | |
Defined in Graphics.Vulkan.Core10.SharedTypes | |
ToCStruct Extent3D Source # | |
Defined in Graphics.Vulkan.Core10.SharedTypes | |
Zero Extent3D Source # | |
Defined in Graphics.Vulkan.Core10.SharedTypes |
data ImageSubresourceLayers Source #
VkImageSubresourceLayers - Structure specifying an image subresource layers
Valid Usage
- If
aspectMask
containsIMAGE_ASPECT_COLOR_BIT
, it must not contain either ofIMAGE_ASPECT_DEPTH_BIT
orIMAGE_ASPECT_STENCIL_BIT
aspectMask
must not containIMAGE_ASPECT_METADATA_BIT
aspectMask
must not includeVK_IMAGE_ASPECT_MEMORY_PLANE_i_BIT_EXT
for any indexi
.layerCount
must be greater than 0
Valid Usage (Implicit)
aspectMask
must be a valid combination ofImageAspectFlagBits
values
aspectMask
must not be0
See Also
BufferImageCopy
,
ImageAspectFlags
,
ImageBlit
,
ImageCopy
,
ImageResolve
ImageSubresourceLayers | |
|
Instances
data ImageSubresourceRange Source #
VkImageSubresourceRange - Structure specifying an image subresource range
Description
The number of mipmap levels and array layers must be a subset of the
image subresources in the image. If an application wants to use all mip
levels or layers in an image after the baseMipLevel
or
baseArrayLayer
, it can set levelCount
and layerCount
to the
special values
REMAINING_MIP_LEVELS
and
REMAINING_ARRAY_LAYERS
without
knowing the exact number of mip levels or layers.
For cube and cube array image views, the layers of the image view
starting at baseArrayLayer
correspond to faces in the order +X, -X,
+Y, -Y, +Z, -Z. For cube arrays, each set of six sequential layers is a
single cube, so the number of cube maps in a cube map array view is
layerCount
/ 6, and image array layer (baseArrayLayer
+ i) is
face index (i mod 6) of cube i / 6. If the number of layers in the
view, whether set explicitly in layerCount
or implied by
REMAINING_ARRAY_LAYERS
, is not a
multiple of 6, the last cube map in the array must not be accessed.
aspectMask
must be only
IMAGE_ASPECT_COLOR_BIT
,
IMAGE_ASPECT_DEPTH_BIT
or
IMAGE_ASPECT_STENCIL_BIT
if Format
is a color, depth-only
or stencil-only format, respectively, except if
Format
is a
multi-planar format.
If using a depth/stencil format with both depth and stencil components,
aspectMask
must include at least one of
IMAGE_ASPECT_DEPTH_BIT
and
IMAGE_ASPECT_STENCIL_BIT
,
and can include both.
When the ImageSubresourceRange
structure is used to select a subset of
the slices of a 3D image’s mip level in order to create a 2D or 2D array
image view of a 3D image created with
IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT
,
baseArrayLayer
and layerCount
specify the first slice index and the
number of slices to include in the created image view. Such an image
view can be used as a framebuffer attachment that refers only to the
specified range of slices of the selected mip level. However, any layout
transitions performed on such an attachment view during a render pass
instance still apply to the entire subresource referenced which includes
all the slices of the selected mip level.
When using an image view of a depth/stencil image to populate a
descriptor set (e.g. for sampling in the shader, or for use as an input
attachment), the aspectMask
must only include one bit and selects
whether the image view is used for depth reads (i.e. using a
floating-point sampler or input attachment in the shader) or stencil
reads (i.e. using an unsigned integer sampler or input attachment in the
shader). When an image view of a depth/stencil image is used as a
depth/stencil framebuffer attachment, the aspectMask
is ignored and
both depth and stencil image subresources are used.
The ComponentMapping
components
member describes a remapping from components of the image to components
of the vector returned by shader image instructions. This remapping
must be identity for storage image descriptors, input attachment
descriptors, framebuffer attachments, and any
ImageView
used with a combined image
sampler that enables
sampler Y′CBCR conversion.
When creating a ImageView
, if
sampler Y′CBCR conversion
is enabled in the sampler, the aspectMask
of a subresourceRange
used
by the ImageView
must be
IMAGE_ASPECT_COLOR_BIT
.
When creating a ImageView
, if sampler
Y′CBCR conversion is not enabled in the sampler and the image
Format
is
multi-planar,
the image must have been created with
IMAGE_CREATE_MUTABLE_FORMAT_BIT
,
and the aspectMask
of the ImageView
’s
subresourceRange
must be
IMAGE_ASPECT_PLANE_0_BIT
,
IMAGE_ASPECT_PLANE_1_BIT
or
IMAGE_ASPECT_PLANE_2_BIT
.
Valid Usage
- If
levelCount
is notREMAINING_MIP_LEVELS
, it must be greater than0
- If
layerCount
is notREMAINING_ARRAY_LAYERS
, it must be greater than0
- If
aspectMask
includesIMAGE_ASPECT_COLOR_BIT
, then it must not include any ofIMAGE_ASPECT_PLANE_0_BIT
,IMAGE_ASPECT_PLANE_1_BIT
, orIMAGE_ASPECT_PLANE_2_BIT
aspectMask
must not includeVK_IMAGE_ASPECT_MEMORY_PLANE_i_BIT_EXT
for any indexi
Valid Usage (Implicit)
aspectMask
must be a valid combination ofImageAspectFlagBits
values
aspectMask
must not be0
See Also
ImageAspectFlags
,
ImageMemoryBarrier
,
ImageViewCreateInfo
,
cmdClearColorImage
,
cmdClearDepthStencilImage
ImageSubresourceRange | |
|
Instances
data ClearDepthStencilValue Source #
VkClearDepthStencilValue - Structure specifying a clear depth stencil value
Valid Usage
- Unless the
https://www.khronos.org/registry/vulkan/specs/1.2-extensions/html/vkspec.html#VK_EXT_depth_range_unrestricted
extension is enableddepth
must be between0.0
and1.0
, inclusive
See Also
ClearDepthStencilValue | |
|
Instances
data ClearColorValue Source #
Float32 (Float, Float, Float, Float) | |
Int32 (Int32, Int32, Int32, Int32) | |
Uint32 (Word32, Word32, Word32, Word32) |
Instances
Show ClearColorValue Source # | |
Defined in Graphics.Vulkan.Core10.SharedTypes showsPrec :: Int -> ClearColorValue -> ShowS # show :: ClearColorValue -> String # showList :: [ClearColorValue] -> ShowS # | |
ToCStruct ClearColorValue Source # | |
Defined in Graphics.Vulkan.Core10.SharedTypes withCStruct :: ClearColorValue -> (Ptr ClearColorValue -> IO b) -> IO b Source # pokeCStruct :: Ptr ClearColorValue -> ClearColorValue -> IO b -> IO b Source # withZeroCStruct :: (Ptr ClearColorValue -> IO b) -> IO b Source # pokeZeroCStruct :: Ptr ClearColorValue -> IO b -> IO b Source # cStructSize :: Int Source # | |
Zero ClearColorValue Source # | |
Defined in Graphics.Vulkan.Core10.SharedTypes |
data ClearValue Source #
Instances
Show ClearValue Source # | |
Defined in Graphics.Vulkan.Core10.SharedTypes showsPrec :: Int -> ClearValue -> ShowS # show :: ClearValue -> String # showList :: [ClearValue] -> ShowS # | |
ToCStruct ClearValue Source # | |
Defined in Graphics.Vulkan.Core10.SharedTypes withCStruct :: ClearValue -> (Ptr ClearValue -> IO b) -> IO b Source # pokeCStruct :: Ptr ClearValue -> ClearValue -> IO b -> IO b Source # withZeroCStruct :: (Ptr ClearValue -> IO b) -> IO b Source # pokeZeroCStruct :: Ptr ClearValue -> IO b -> IO b Source # cStructSize :: Int Source # | |
Zero ClearValue Source # | |
Defined in Graphics.Vulkan.Core10.SharedTypes zero :: ClearValue Source # |