Safe Haskell	Safe-Inferred
Language	Haskell2010

Vulkan.Core11.Promoted_From_VK_KHR_maintenance1

Synopsis

trimCommandPool :: forall io. MonadIO io => Device -> CommandPool -> CommandPoolTrimFlags -> io ()
newtype CommandPoolTrimFlags = CommandPoolTrimFlags Flags
newtype Result where
- Result Int32
- pattern SUCCESS :: Result
- pattern NOT_READY :: Result
- pattern TIMEOUT :: Result
- pattern EVENT_SET :: Result
- pattern EVENT_RESET :: Result
- pattern INCOMPLETE :: Result
- pattern ERROR_OUT_OF_HOST_MEMORY :: Result
- pattern ERROR_OUT_OF_DEVICE_MEMORY :: Result
- pattern ERROR_INITIALIZATION_FAILED :: Result
- pattern ERROR_DEVICE_LOST :: Result
- pattern ERROR_MEMORY_MAP_FAILED :: Result
- pattern ERROR_LAYER_NOT_PRESENT :: Result
- pattern ERROR_EXTENSION_NOT_PRESENT :: Result
- pattern ERROR_FEATURE_NOT_PRESENT :: Result
- pattern ERROR_INCOMPATIBLE_DRIVER :: Result
- pattern ERROR_TOO_MANY_OBJECTS :: Result
- pattern ERROR_FORMAT_NOT_SUPPORTED :: Result
- pattern ERROR_FRAGMENTED_POOL :: Result
- pattern ERROR_UNKNOWN :: Result
- pattern ERROR_INCOMPATIBLE_SHADER_BINARY_EXT :: Result
- pattern ERROR_COMPRESSION_EXHAUSTED_EXT :: Result
- pattern OPERATION_NOT_DEFERRED_KHR :: Result
- pattern OPERATION_DEFERRED_KHR :: Result
- pattern THREAD_DONE_KHR :: Result
- pattern THREAD_IDLE_KHR :: Result
- pattern ERROR_FULL_SCREEN_EXCLUSIVE_MODE_LOST_EXT :: Result
- pattern ERROR_NOT_PERMITTED_KHR :: Result
- pattern ERROR_INVALID_DRM_FORMAT_MODIFIER_PLANE_LAYOUT_EXT :: Result
- pattern ERROR_INVALID_SHADER_NV :: Result
- pattern ERROR_VALIDATION_FAILED_EXT :: Result
- pattern ERROR_INCOMPATIBLE_DISPLAY_KHR :: Result
- pattern ERROR_OUT_OF_DATE_KHR :: Result
- pattern SUBOPTIMAL_KHR :: Result
- pattern ERROR_NATIVE_WINDOW_IN_USE_KHR :: Result
- pattern ERROR_SURFACE_LOST_KHR :: Result
- pattern ERROR_NO_PIPELINE_MATCH :: Result
- pattern ERROR_INVALID_PIPELINE_CACHE_DATA :: Result
- pattern ERROR_VALIDATION_FAILED :: Result
- pattern PIPELINE_COMPILE_REQUIRED :: Result
- pattern ERROR_INVALID_OPAQUE_CAPTURE_ADDRESS :: Result
- pattern ERROR_FRAGMENTATION :: Result
- pattern ERROR_INVALID_EXTERNAL_HANDLE :: Result
- pattern ERROR_OUT_OF_POOL_MEMORY :: Result
newtype ImageCreateFlagBits where
- ImageCreateFlagBits Flags
- pattern IMAGE_CREATE_SPARSE_BINDING_BIT :: ImageCreateFlagBits
- pattern IMAGE_CREATE_SPARSE_RESIDENCY_BIT :: ImageCreateFlagBits
- pattern IMAGE_CREATE_SPARSE_ALIASED_BIT :: ImageCreateFlagBits
- pattern IMAGE_CREATE_MUTABLE_FORMAT_BIT :: ImageCreateFlagBits
- pattern IMAGE_CREATE_CUBE_COMPATIBLE_BIT :: ImageCreateFlagBits
- pattern IMAGE_CREATE_FRAGMENT_DENSITY_MAP_OFFSET_BIT_QCOM :: ImageCreateFlagBits
- pattern IMAGE_CREATE_2D_VIEW_COMPATIBLE_BIT_EXT :: ImageCreateFlagBits
- pattern IMAGE_CREATE_MULTISAMPLED_RENDER_TO_SINGLE_SAMPLED_BIT_EXT :: ImageCreateFlagBits
- pattern IMAGE_CREATE_DESCRIPTOR_BUFFER_CAPTURE_REPLAY_BIT_EXT :: ImageCreateFlagBits
- pattern IMAGE_CREATE_SUBSAMPLED_BIT_EXT :: ImageCreateFlagBits
- pattern IMAGE_CREATE_SAMPLE_LOCATIONS_COMPATIBLE_DEPTH_BIT_EXT :: ImageCreateFlagBits
- pattern IMAGE_CREATE_CORNER_SAMPLED_BIT_NV :: ImageCreateFlagBits
- pattern IMAGE_CREATE_DISJOINT_BIT :: ImageCreateFlagBits
- pattern IMAGE_CREATE_PROTECTED_BIT :: ImageCreateFlagBits
- pattern IMAGE_CREATE_EXTENDED_USAGE_BIT :: ImageCreateFlagBits
- pattern IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT :: ImageCreateFlagBits
- pattern IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT :: ImageCreateFlagBits
- pattern IMAGE_CREATE_SPLIT_INSTANCE_BIND_REGIONS_BIT :: ImageCreateFlagBits
- pattern IMAGE_CREATE_ALIAS_BIT :: ImageCreateFlagBits
type ImageCreateFlags = ImageCreateFlagBits
newtype FormatFeatureFlagBits where
- FormatFeatureFlagBits Flags
- pattern FORMAT_FEATURE_SAMPLED_IMAGE_BIT :: FormatFeatureFlagBits
- pattern FORMAT_FEATURE_STORAGE_IMAGE_BIT :: FormatFeatureFlagBits
- pattern FORMAT_FEATURE_STORAGE_IMAGE_ATOMIC_BIT :: FormatFeatureFlagBits
- pattern FORMAT_FEATURE_UNIFORM_TEXEL_BUFFER_BIT :: FormatFeatureFlagBits
- pattern FORMAT_FEATURE_STORAGE_TEXEL_BUFFER_BIT :: FormatFeatureFlagBits
- pattern FORMAT_FEATURE_STORAGE_TEXEL_BUFFER_ATOMIC_BIT :: FormatFeatureFlagBits
- pattern FORMAT_FEATURE_VERTEX_BUFFER_BIT :: FormatFeatureFlagBits
- pattern FORMAT_FEATURE_COLOR_ATTACHMENT_BIT :: FormatFeatureFlagBits
- pattern FORMAT_FEATURE_COLOR_ATTACHMENT_BLEND_BIT :: FormatFeatureFlagBits
- pattern FORMAT_FEATURE_DEPTH_STENCIL_ATTACHMENT_BIT :: FormatFeatureFlagBits
- pattern FORMAT_FEATURE_BLIT_SRC_BIT :: FormatFeatureFlagBits
- pattern FORMAT_FEATURE_BLIT_DST_BIT :: FormatFeatureFlagBits
- pattern FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_LINEAR_BIT :: FormatFeatureFlagBits
- pattern FORMAT_FEATURE_FRAGMENT_SHADING_RATE_ATTACHMENT_BIT_KHR :: FormatFeatureFlagBits
- pattern FORMAT_FEATURE_FRAGMENT_DENSITY_MAP_BIT_EXT :: FormatFeatureFlagBits
- pattern FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_CUBIC_BIT_EXT :: FormatFeatureFlagBits
- pattern FORMAT_FEATURE_ACCELERATION_STRUCTURE_VERTEX_BUFFER_BIT_KHR :: FormatFeatureFlagBits
- pattern FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_MINMAX_BIT :: FormatFeatureFlagBits
- pattern FORMAT_FEATURE_COSITED_CHROMA_SAMPLES_BIT :: FormatFeatureFlagBits
- pattern FORMAT_FEATURE_DISJOINT_BIT :: FormatFeatureFlagBits
- pattern FORMAT_FEATURE_SAMPLED_IMAGE_YCBCR_CONVERSION_CHROMA_RECONSTRUCTION_EXPLICIT_FORCEABLE_BIT :: FormatFeatureFlagBits
- pattern FORMAT_FEATURE_SAMPLED_IMAGE_YCBCR_CONVERSION_CHROMA_RECONSTRUCTION_EXPLICIT_BIT :: FormatFeatureFlagBits
- pattern FORMAT_FEATURE_SAMPLED_IMAGE_YCBCR_CONVERSION_SEPARATE_RECONSTRUCTION_FILTER_BIT :: FormatFeatureFlagBits
- pattern FORMAT_FEATURE_SAMPLED_IMAGE_YCBCR_CONVERSION_LINEAR_FILTER_BIT :: FormatFeatureFlagBits
- pattern FORMAT_FEATURE_MIDPOINT_CHROMA_SAMPLES_BIT :: FormatFeatureFlagBits
- pattern FORMAT_FEATURE_TRANSFER_DST_BIT :: FormatFeatureFlagBits
- pattern FORMAT_FEATURE_TRANSFER_SRC_BIT :: FormatFeatureFlagBits
type FormatFeatureFlags = FormatFeatureFlagBits

Documentation

trimCommandPool Source #

Arguments

:: forall io. MonadIO io
=> Device	`device` is the logical device that owns the command pool.
-> CommandPool	`commandPool` is the command pool to trim.
-> CommandPoolTrimFlags	`flags` is reserved for future use.
-> io ()

vkTrimCommandPool - Trim a command pool

Description

Trimming a command pool recycles unused memory from the command pool back to the system. Command buffers allocated from the pool are not affected by the command.

Note

This command provides applications with some control over the internal memory allocations used by command pools.

Unused memory normally arises from command buffers that have been recorded and later reset, such that they are no longer using the memory. On reset, a command buffer can return memory to its command pool, but the only way to release memory from a command pool to the system requires calling resetCommandPool, which cannot be executed while any command buffers from that pool are still in use. Subsequent recording operations into command buffers will reuse this memory but since total memory requirements fluctuate over time, unused memory can accumulate.

In this situation, trimming a command pool may be useful to return unused memory back to the system, returning the total outstanding memory allocated by the pool back to a more “average” value.

Implementations utilize many internal allocation strategies that make it impossible to guarantee that all unused memory is released back to the system. For instance, an implementation of a command pool may involve allocating memory in bulk from the system and sub-allocating from that memory. In such an implementation any live command buffer that holds a reference to a bulk allocation would prevent that allocation from being freed, even if only a small proportion of the bulk allocation is in use.

In most cases trimming will result in a reduction in allocated but unused memory, but it does not guarantee the “ideal” behavior.

Trimming may be an expensive operation, and should not be called frequently. Trimming should be treated as a way to relieve memory pressure after application-known points when there exists enough unused memory that the cost of trimming is “worth” it.

Valid Usage (Implicit)

device must be a valid Device handle

commandPool must be a valid CommandPool handle
flags must be 0
commandPool must have been created, allocated, or retrieved from device

Host Synchronization

Host access to commandPool must be externally synchronized

Description

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

Description

If a command returns a runtime error, unless otherwise specified any output parameters will have undefined contents, except that if the output parameter is a structure with sType and pNext fields, those fields will be unmodified. Any structures chained from pNext will also have undefined contents, except that sType and pNext will be unmodified.

VK_ERROR_OUT_OF_*_MEMORY errors do not modify any currently existing Vulkan objects. Objects that have already been successfully created can still be used by the application.

Note

As a general rule, Free, Release, and Reset commands do not return ERROR_OUT_OF_HOST_MEMORY, while any other command with a return code may return it. Any exceptions from this rule are described for those commands.

ERROR_UNKNOWN will be returned by an implementation when an unexpected error occurs that cannot be attributed to valid behavior of the application and implementation. Under these conditions, it may be returned from any command returning a Result.

Note

ERROR_UNKNOWN is not expected to ever be returned if the application behavior is valid, and if the implementation is bug-free. If ERROR_UNKNOWN is received, the application should be checked against the latest validation layers to verify correct behavior as much as possible. If no issues are identified it could be an implementation issue, and the implementor should be contacted for support.

Any command returning a Result may return ERROR_VALIDATION_FAILED_EXT if a violation of valid usage is detected, even though commands do not explicitly list this as a possible return code.

Performance-critical commands generally do not have return codes. If a runtime error occurs in such commands, the implementation will defer reporting the error until a specified point. For commands that record into command buffers (vkCmd*) runtime errors are reported by endCommandBuffer.

Description

See Sparse Resource Features and Sparse Physical Device Features for more details.

Description

These values all have the same meaning as the equivalently named values for FormatFeatureFlags2 and may be set in linearTilingFeatures, optimalTilingFeatures, and DrmFormatModifierPropertiesEXT::drmFormatModifierTilingFeatures, specifying that the features are supported by images or image views or sampler Y′CBCR conversion objects created with the queried getPhysicalDeviceFormatProperties::format:

FORMAT_FEATURE_SAMPLED_IMAGE_BIT specifies that an image view can be sampled from.
FORMAT_FEATURE_STORAGE_IMAGE_BIT specifies that an image view can be used as a storage image.
FORMAT_FEATURE_STORAGE_IMAGE_ATOMIC_BIT specifies that an image view can be used as storage image that supports atomic operations.
FORMAT_FEATURE_COLOR_ATTACHMENT_BIT specifies that an image view can be used as a framebuffer color attachment and as an input attachment.
FORMAT_FEATURE_COLOR_ATTACHMENT_BLEND_BIT specifies that an image view can be used as a framebuffer color attachment that supports blending.
FORMAT_FEATURE_DEPTH_STENCIL_ATTACHMENT_BIT specifies that an image view can be used as a framebuffer depth/stencil attachment and as an input attachment.
FORMAT_FEATURE_BLIT_SRC_BIT specifies that an image can be used as srcImage for the cmdBlitImage2 and cmdBlitImage commands.
FORMAT_FEATURE_BLIT_DST_BIT specifies that an image can be used as dstImage for the cmdBlitImage2 and cmdBlitImage commands.
FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_LINEAR_BIT specifies that if FORMAT_FEATURE_SAMPLED_IMAGE_BIT is also set, an image view can be used with a sampler that has either of magFilter or minFilter set to FILTER_LINEAR, or mipmapMode set to SAMPLER_MIPMAP_MODE_LINEAR. If FORMAT_FEATURE_BLIT_SRC_BIT is also set, an image can be used as the srcImage to cmdBlitImage2 and cmdBlitImage with a filter of FILTER_LINEAR. This bit must only be exposed for formats that also support the FORMAT_FEATURE_SAMPLED_IMAGE_BIT or FORMAT_FEATURE_BLIT_SRC_BIT.
If the format being queried is a depth/stencil format, this bit only specifies that the depth aspect (not the stencil aspect) of an image of this format supports linear filtering, and that linear filtering of the depth aspect is supported whether depth compare is enabled in the sampler or not. Where depth comparison is supported it may be linear filtered whether this bit is present or not, but where this bit is not present the filtered value may be computed in an implementation-dependent manner which differs from the normal rules of linear filtering. The resulting value must be in the range [0,1] and should be proportional to, or a weighted average of, the number of comparison passes or failures.
FORMAT_FEATURE_TRANSFER_SRC_BIT specifies that an image can be used as a source image for copy commands. If the application apiVersion is Vulkan 1.0 and VK_KHR_maintenance1 is not supported, FORMAT_FEATURE_TRANSFER_SRC_BIT is implied to be set when the format feature flag is not 0.
FORMAT_FEATURE_TRANSFER_DST_BIT specifies that an image can be used as a destination image for copy commands and clear commands. If the application apiVersion is Vulkan 1.0 and VK_KHR_maintenance1 is not supported, FORMAT_FEATURE_TRANSFER_DST_BIT is implied to be set when the format feature flag is not 0.
FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_MINMAX_BIT specifies Image can be used as a sampled image with a min or max SamplerReductionMode. This bit must only be exposed for formats that also support the FORMAT_FEATURE_SAMPLED_IMAGE_BIT.
FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_CUBIC_BIT_EXT specifies that Image can be used with a sampler that has either of magFilter or minFilter set to FILTER_CUBIC_EXT, or be the source image for a blit with filter set to FILTER_CUBIC_EXT. This bit must only be exposed for formats that also support the FORMAT_FEATURE_SAMPLED_IMAGE_BIT. If the format being queried is a depth/stencil format, this only specifies that the depth aspect is cubic filterable.
FORMAT_FEATURE_MIDPOINT_CHROMA_SAMPLES_BIT specifies that an application can define a sampler Y′CBCR conversion using this format as a source, and that an image of this format can be used with a SamplerYcbcrConversionCreateInfo xChromaOffset and/or yChromaOffset of CHROMA_LOCATION_MIDPOINT. Otherwise both xChromaOffset and yChromaOffset must be CHROMA_LOCATION_COSITED_EVEN. If a format does not incorporate chroma downsampling (it is not a “422” or “420” format) but the implementation supports sampler Y′CBCR conversion for this format, the implementation must set FORMAT_FEATURE_MIDPOINT_CHROMA_SAMPLES_BIT.
FORMAT_FEATURE_COSITED_CHROMA_SAMPLES_BIT specifies that an application can define a sampler Y′CBCR conversion using this format as a source, and that an image of this format can be used with a SamplerYcbcrConversionCreateInfo xChromaOffset and/or yChromaOffset of CHROMA_LOCATION_COSITED_EVEN. Otherwise both xChromaOffset and yChromaOffset must be CHROMA_LOCATION_MIDPOINT. If neither FORMAT_FEATURE_COSITED_CHROMA_SAMPLES_BIT nor FORMAT_FEATURE_MIDPOINT_CHROMA_SAMPLES_BIT is set, the application must not define a sampler Y′CBCR conversion using this format as a source.
FORMAT_FEATURE_SAMPLED_IMAGE_YCBCR_CONVERSION_LINEAR_FILTER_BIT specifies that an application can define a sampler Y′CBCR conversion using this format as a source with chromaFilter set to FILTER_LINEAR.
FORMAT_FEATURE_SAMPLED_IMAGE_YCBCR_CONVERSION_SEPARATE_RECONSTRUCTION_FILTER_BIT specifies that the format can have different chroma, min, and mag filters.
FORMAT_FEATURE_SAMPLED_IMAGE_YCBCR_CONVERSION_CHROMA_RECONSTRUCTION_EXPLICIT_BIT specifies that reconstruction is explicit, as described in https://registry.khronos.org/vulkan/specs/1.3-extensions/html/vkspec.html#textures-chroma-reconstruction. If this bit is not present, reconstruction is implicit by default.
FORMAT_FEATURE_SAMPLED_IMAGE_YCBCR_CONVERSION_CHROMA_RECONSTRUCTION_EXPLICIT_FORCEABLE_BIT specifies that reconstruction can be forcibly made explicit by setting SamplerYcbcrConversionCreateInfo::forceExplicitReconstruction to TRUE. If the format being queried supports FORMAT_FEATURE_SAMPLED_IMAGE_YCBCR_CONVERSION_CHROMA_RECONSTRUCTION_EXPLICIT_BIT it must also support FORMAT_FEATURE_SAMPLED_IMAGE_YCBCR_CONVERSION_CHROMA_RECONSTRUCTION_EXPLICIT_FORCEABLE_BIT.
FORMAT_FEATURE_DISJOINT_BIT specifies that a multi-planar image can have the IMAGE_CREATE_DISJOINT_BIT set during image creation. An implementation must not set FORMAT_FEATURE_DISJOINT_BIT for single-plane formats.
FORMAT_FEATURE_FRAGMENT_DENSITY_MAP_BIT_EXT specifies that an image view can be used as a fragment density map attachment.
FORMAT_FEATURE_FRAGMENT_SHADING_RATE_ATTACHMENT_BIT_KHR specifies that an image view can be used as a fragment shading rate attachment. An implementation must not set this feature for formats with a numeric format other than UINT, or set it as a buffer feature.
VK_FORMAT_FEATURE_VIDEO_DECODE_OUTPUT_BIT_KHR specifies that an image view with this format can be used as a decode output picture in video decode operations.
VK_FORMAT_FEATURE_VIDEO_DECODE_DPB_BIT_KHR specifies that an image view with this format can be used as an output reconstructed picture or an input reference picture in video decode operations.
VK_FORMAT_FEATURE_VIDEO_ENCODE_INPUT_BIT_KHR specifies that an image view with this format can be used as an encode input picture in video encode operations.
VK_FORMAT_FEATURE_VIDEO_ENCODE_DPB_BIT_KHR specifies that an image view with this format can be used as an output reconstructed picture or an input reference picture in video encode operations.
Note
Specific video profiles may have additional restrictions on the format and other image creation parameters corresponding to image views used by video coding operations that can be enumerated using the vkGetPhysicalDeviceVideoFormatPropertiesKHR command.

The following bits may be set in bufferFeatures, specifying that the features are supported by buffers or buffer views created with the queried getPhysicalDeviceFormatProperties::format:

FORMAT_FEATURE_UNIFORM_TEXEL_BUFFER_BIT specifies that the format can be used to create a buffer view that can be bound to a DESCRIPTOR_TYPE_UNIFORM_TEXEL_BUFFER descriptor.
FORMAT_FEATURE_STORAGE_TEXEL_BUFFER_BIT specifies that the format can be used to create a buffer view that can be bound to a DESCRIPTOR_TYPE_STORAGE_TEXEL_BUFFER descriptor.
FORMAT_FEATURE_STORAGE_TEXEL_BUFFER_ATOMIC_BIT specifies that atomic operations are supported on DESCRIPTOR_TYPE_STORAGE_TEXEL_BUFFER with this format.
FORMAT_FEATURE_VERTEX_BUFFER_BIT specifies that the format can be used as a vertex attribute format (VertexInputAttributeDescription::format).
FORMAT_FEATURE_ACCELERATION_STRUCTURE_VERTEX_BUFFER_BIT_KHR specifies that the format can be used as the vertex format when creating an acceleration structure (AccelerationStructureGeometryTrianglesDataKHR::vertexFormat). This format can also be used as the vertex format in host memory when doing host acceleration structure builds.

Note

FORMAT_FEATURE_STORAGE_IMAGE_ATOMIC_BIT and FORMAT_FEATURE_STORAGE_TEXEL_BUFFER_ATOMIC_BIT are only intended to be advertised for single-component formats, since SPIR-V atomic operations require a scalar type.

pattern FORMAT_FEATURE_SAMPLED_IMAGE_BIT :: FormatFeatureFlagBits	`FORMAT_FEATURE_SAMPLED_IMAGE_BIT` specifies that an image view can be sampled from.
pattern FORMAT_FEATURE_STORAGE_IMAGE_BIT :: FormatFeatureFlagBits	`FORMAT_FEATURE_STORAGE_IMAGE_BIT` specifies that an image view can be used as a storage image.
pattern FORMAT_FEATURE_STORAGE_IMAGE_ATOMIC_BIT :: FormatFeatureFlagBits	`FORMAT_FEATURE_STORAGE_IMAGE_ATOMIC_BIT` specifies that an image view can be used as storage image that supports atomic operations.
pattern FORMAT_FEATURE_UNIFORM_TEXEL_BUFFER_BIT :: FormatFeatureFlagBits	`FORMAT_FEATURE_UNIFORM_TEXEL_BUFFER_BIT` specifies that the format can be used to create a buffer view that can be bound to a `DESCRIPTOR_TYPE_UNIFORM_TEXEL_BUFFER` descriptor.
pattern FORMAT_FEATURE_STORAGE_TEXEL_BUFFER_BIT :: FormatFeatureFlagBits	`FORMAT_FEATURE_STORAGE_TEXEL_BUFFER_BIT` specifies that the format can be used to create a buffer view that can be bound to a `DESCRIPTOR_TYPE_STORAGE_TEXEL_BUFFER` descriptor.
pattern FORMAT_FEATURE_STORAGE_TEXEL_BUFFER_ATOMIC_BIT :: FormatFeatureFlagBits	`FORMAT_FEATURE_STORAGE_TEXEL_BUFFER_ATOMIC_BIT` specifies that atomic operations are supported on `DESCRIPTOR_TYPE_STORAGE_TEXEL_BUFFER` with this format.
pattern FORMAT_FEATURE_VERTEX_BUFFER_BIT :: FormatFeatureFlagBits	`FORMAT_FEATURE_VERTEX_BUFFER_BIT` specifies that the format can be used as a vertex attribute format (`VertexInputAttributeDescription`::`format`).
pattern FORMAT_FEATURE_COLOR_ATTACHMENT_BIT :: FormatFeatureFlagBits	`FORMAT_FEATURE_COLOR_ATTACHMENT_BIT` specifies that an image view can be used as a framebuffer color attachment and as an input attachment.
pattern FORMAT_FEATURE_COLOR_ATTACHMENT_BLEND_BIT :: FormatFeatureFlagBits	`FORMAT_FEATURE_COLOR_ATTACHMENT_BLEND_BIT` specifies that an image view can be used as a framebuffer color attachment that supports blending.
pattern FORMAT_FEATURE_DEPTH_STENCIL_ATTACHMENT_BIT :: FormatFeatureFlagBits	`FORMAT_FEATURE_DEPTH_STENCIL_ATTACHMENT_BIT` specifies that an image view can be used as a framebuffer depth/stencil attachment and as an input attachment.
pattern FORMAT_FEATURE_BLIT_SRC_BIT :: FormatFeatureFlagBits	`FORMAT_FEATURE_BLIT_SRC_BIT` specifies that an image can be used as `srcImage` for the `cmdBlitImage2` and `cmdBlitImage` commands.
pattern FORMAT_FEATURE_BLIT_DST_BIT :: FormatFeatureFlagBits	`FORMAT_FEATURE_BLIT_DST_BIT` specifies that an image can be used as `dstImage` for the `cmdBlitImage2` and `cmdBlitImage` commands.
pattern FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_LINEAR_BIT :: FormatFeatureFlagBits	`FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_LINEAR_BIT` specifies that if `FORMAT_FEATURE_SAMPLED_IMAGE_BIT` is also set, an image view can be used with a sampler that has either of `magFilter` or `minFilter` set to `FILTER_LINEAR`, or `mipmapMode` set to `SAMPLER_MIPMAP_MODE_LINEAR`. If `FORMAT_FEATURE_BLIT_SRC_BIT` is also set, an image can be used as the `srcImage` to `cmdBlitImage2` and `cmdBlitImage` with a `filter` of `FILTER_LINEAR`. This bit must only be exposed for formats that also support the `FORMAT_FEATURE_SAMPLED_IMAGE_BIT` or `FORMAT_FEATURE_BLIT_SRC_BIT`. If the format being queried is a depth/stencil format, this bit only specifies that the depth aspect (not the stencil aspect) of an image of this format supports linear filtering, and that linear filtering of the depth aspect is supported whether depth compare is enabled in the sampler or not. Where depth comparison is supported it may be linear filtered whether this bit is present or not, but where this bit is not present the filtered value may be computed in an implementation-dependent manner which differs from the normal rules of linear filtering. The resulting value must be in the range [0,1] and should be proportional to, or a weighted average of, the number of comparison passes or failures.
pattern FORMAT_FEATURE_FRAGMENT_SHADING_RATE_ATTACHMENT_BIT_KHR :: FormatFeatureFlagBits	`FORMAT_FEATURE_FRAGMENT_SHADING_RATE_ATTACHMENT_BIT_KHR` specifies that an image view can be used as a fragment shading rate attachment. An implementation must not set this feature for formats with a numeric format other than `UINT`, or set it as a buffer feature.
pattern FORMAT_FEATURE_FRAGMENT_DENSITY_MAP_BIT_EXT :: FormatFeatureFlagBits	`FORMAT_FEATURE_FRAGMENT_DENSITY_MAP_BIT_EXT` specifies that an image view can be used as a fragment density map attachment.
pattern FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_CUBIC_BIT_EXT :: FormatFeatureFlagBits	`FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_CUBIC_BIT_EXT` specifies that `Image` can be used with a sampler that has either of `magFilter` or `minFilter` set to `FILTER_CUBIC_EXT`, or be the source image for a blit with `filter` set to `FILTER_CUBIC_EXT`. This bit must only be exposed for formats that also support the `FORMAT_FEATURE_SAMPLED_IMAGE_BIT`. If the format being queried is a depth/stencil format, this only specifies that the depth aspect is cubic filterable.
pattern FORMAT_FEATURE_ACCELERATION_STRUCTURE_VERTEX_BUFFER_BIT_KHR :: FormatFeatureFlagBits	`FORMAT_FEATURE_ACCELERATION_STRUCTURE_VERTEX_BUFFER_BIT_KHR` specifies that the format can be used as the vertex format when creating an acceleration structure (`AccelerationStructureGeometryTrianglesDataKHR`::`vertexFormat`). This format can also be used as the vertex format in host memory when doing host acceleration structure builds.
pattern FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_MINMAX_BIT :: FormatFeatureFlagBits	`FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_MINMAX_BIT` specifies `Image` can be used as a sampled image with a min or max `SamplerReductionMode`. This bit must only be exposed for formats that also support the `FORMAT_FEATURE_SAMPLED_IMAGE_BIT`.
pattern FORMAT_FEATURE_COSITED_CHROMA_SAMPLES_BIT :: FormatFeatureFlagBits	`FORMAT_FEATURE_COSITED_CHROMA_SAMPLES_BIT` specifies that an application can define a sampler Y′CBCR conversion using this format as a source, and that an image of this format can be used with a `SamplerYcbcrConversionCreateInfo` `xChromaOffset` and/or `yChromaOffset` of `CHROMA_LOCATION_COSITED_EVEN`. Otherwise both `xChromaOffset` and `yChromaOffset` must be `CHROMA_LOCATION_MIDPOINT`. If neither `FORMAT_FEATURE_COSITED_CHROMA_SAMPLES_BIT` nor `FORMAT_FEATURE_MIDPOINT_CHROMA_SAMPLES_BIT` is set, the application must not define a sampler Y′CBCR conversion using this format as a source.
pattern FORMAT_FEATURE_DISJOINT_BIT :: FormatFeatureFlagBits	`FORMAT_FEATURE_DISJOINT_BIT` specifies that a multi-planar image can have the `IMAGE_CREATE_DISJOINT_BIT` set during image creation. An implementation must not set `FORMAT_FEATURE_DISJOINT_BIT` for single-plane formats.
pattern FORMAT_FEATURE_SAMPLED_IMAGE_YCBCR_CONVERSION_CHROMA_RECONSTRUCTION_EXPLICIT_FORCEABLE_BIT :: FormatFeatureFlagBits	`FORMAT_FEATURE_SAMPLED_IMAGE_YCBCR_CONVERSION_CHROMA_RECONSTRUCTION_EXPLICIT_FORCEABLE_BIT` specifies that reconstruction can be forcibly made explicit by setting `SamplerYcbcrConversionCreateInfo`::`forceExplicitReconstruction` to `TRUE`. If the format being queried supports `FORMAT_FEATURE_SAMPLED_IMAGE_YCBCR_CONVERSION_CHROMA_RECONSTRUCTION_EXPLICIT_BIT` it must also support `FORMAT_FEATURE_SAMPLED_IMAGE_YCBCR_CONVERSION_CHROMA_RECONSTRUCTION_EXPLICIT_FORCEABLE_BIT`.
pattern FORMAT_FEATURE_SAMPLED_IMAGE_YCBCR_CONVERSION_CHROMA_RECONSTRUCTION_EXPLICIT_BIT :: FormatFeatureFlagBits	`FORMAT_FEATURE_SAMPLED_IMAGE_YCBCR_CONVERSION_CHROMA_RECONSTRUCTION_EXPLICIT_BIT` specifies that reconstruction is explicit, as described in https://registry.khronos.org/vulkan/specs/1.3-extensions/html/vkspec.html#textures-chroma-reconstruction. If this bit is not present, reconstruction is implicit by default.
pattern FORMAT_FEATURE_SAMPLED_IMAGE_YCBCR_CONVERSION_SEPARATE_RECONSTRUCTION_FILTER_BIT :: FormatFeatureFlagBits	`FORMAT_FEATURE_SAMPLED_IMAGE_YCBCR_CONVERSION_SEPARATE_RECONSTRUCTION_FILTER_BIT` specifies that the format can have different chroma, min, and mag filters.
pattern FORMAT_FEATURE_SAMPLED_IMAGE_YCBCR_CONVERSION_LINEAR_FILTER_BIT :: FormatFeatureFlagBits	`FORMAT_FEATURE_SAMPLED_IMAGE_YCBCR_CONVERSION_LINEAR_FILTER_BIT` specifies that an application can define a sampler Y′CBCR conversion using this format as a source with `chromaFilter` set to `FILTER_LINEAR`.
pattern FORMAT_FEATURE_MIDPOINT_CHROMA_SAMPLES_BIT :: FormatFeatureFlagBits	`FORMAT_FEATURE_MIDPOINT_CHROMA_SAMPLES_BIT` specifies that an application can define a sampler Y′CBCR conversion using this format as a source, and that an image of this format can be used with a `SamplerYcbcrConversionCreateInfo` `xChromaOffset` and/or `yChromaOffset` of `CHROMA_LOCATION_MIDPOINT`. Otherwise both `xChromaOffset` and `yChromaOffset` must be `CHROMA_LOCATION_COSITED_EVEN`. If a format does not incorporate chroma downsampling (it is not a “422” or “420” format) but the implementation supports sampler Y′CBCR conversion for this format, the implementation must set `FORMAT_FEATURE_MIDPOINT_CHROMA_SAMPLES_BIT`.
pattern FORMAT_FEATURE_TRANSFER_DST_BIT :: FormatFeatureFlagBits	`FORMAT_FEATURE_TRANSFER_DST_BIT` specifies that an image can be used as a destination image for copy commands and clear commands. If the application `apiVersion` is Vulkan 1.0 and `VK_KHR_maintenance1` is not supported, `FORMAT_FEATURE_TRANSFER_DST_BIT` is implied to be set when the format feature flag is not 0.
pattern FORMAT_FEATURE_TRANSFER_SRC_BIT :: FormatFeatureFlagBits	`FORMAT_FEATURE_TRANSFER_SRC_BIT` specifies that an image can be used as a source image for copy commands. If the application `apiVersion` is Vulkan 1.0 and `VK_KHR_maintenance1` is not supported, `FORMAT_FEATURE_TRANSFER_SRC_BIT` is implied to be set when the format feature flag is not 0.

Instances

Instances details

Storable FormatFeatureFlagBits Source #
Instance details Defined in Vulkan.Core10.Enums.FormatFeatureFlagBits Methods sizeOf :: FormatFeatureFlagBits -> Int # alignment :: FormatFeatureFlagBits -> Int # peekElemOff :: Ptr FormatFeatureFlagBits -> Int -> IO FormatFeatureFlagBits # pokeElemOff :: Ptr FormatFeatureFlagBits -> Int -> FormatFeatureFlagBits -> IO () # peekByteOff :: Ptr b -> Int -> IO FormatFeatureFlagBits # pokeByteOff :: Ptr b -> Int -> FormatFeatureFlagBits -> IO () # peek :: Ptr FormatFeatureFlagBits -> IO FormatFeatureFlagBits # poke :: Ptr FormatFeatureFlagBits -> FormatFeatureFlagBits -> IO () #
Bits FormatFeatureFlagBits Source #
Instance details Defined in Vulkan.Core10.Enums.FormatFeatureFlagBits Methods (.&.) :: FormatFeatureFlagBits -> FormatFeatureFlagBits -> FormatFeatureFlagBits # (.\|.) :: FormatFeatureFlagBits -> FormatFeatureFlagBits -> FormatFeatureFlagBits # xor :: FormatFeatureFlagBits -> FormatFeatureFlagBits -> FormatFeatureFlagBits # complement :: FormatFeatureFlagBits -> FormatFeatureFlagBits # shift :: FormatFeatureFlagBits -> Int -> FormatFeatureFlagBits # rotate :: FormatFeatureFlagBits -> Int -> FormatFeatureFlagBits # zeroBits :: FormatFeatureFlagBits # bit :: Int -> FormatFeatureFlagBits # setBit :: FormatFeatureFlagBits -> Int -> FormatFeatureFlagBits # clearBit :: FormatFeatureFlagBits -> Int -> FormatFeatureFlagBits # complementBit :: FormatFeatureFlagBits -> Int -> FormatFeatureFlagBits # testBit :: FormatFeatureFlagBits -> Int -> Bool # bitSizeMaybe :: FormatFeatureFlagBits -> Maybe Int # bitSize :: FormatFeatureFlagBits -> Int # isSigned :: FormatFeatureFlagBits -> Bool # shiftL :: FormatFeatureFlagBits -> Int -> FormatFeatureFlagBits # unsafeShiftL :: FormatFeatureFlagBits -> Int -> FormatFeatureFlagBits # shiftR :: FormatFeatureFlagBits -> Int -> FormatFeatureFlagBits # unsafeShiftR :: FormatFeatureFlagBits -> Int -> FormatFeatureFlagBits # rotateL :: FormatFeatureFlagBits -> Int -> FormatFeatureFlagBits # rotateR :: FormatFeatureFlagBits -> Int -> FormatFeatureFlagBits # popCount :: FormatFeatureFlagBits -> Int #
FiniteBits FormatFeatureFlagBits Source #
Instance details Defined in Vulkan.Core10.Enums.FormatFeatureFlagBits Methods finiteBitSize :: FormatFeatureFlagBits -> Int # countLeadingZeros :: FormatFeatureFlagBits -> Int # countTrailingZeros :: FormatFeatureFlagBits -> Int #
Read FormatFeatureFlagBits Source #
Instance details Defined in Vulkan.Core10.Enums.FormatFeatureFlagBits Methods readsPrec :: Int -> ReadS FormatFeatureFlagBits # readList :: ReadS [FormatFeatureFlagBits] # readPrec :: ReadPrec FormatFeatureFlagBits # readListPrec :: ReadPrec [FormatFeatureFlagBits] #
Show FormatFeatureFlagBits Source #
Instance details Defined in Vulkan.Core10.Enums.FormatFeatureFlagBits Methods showsPrec :: Int -> FormatFeatureFlagBits -> ShowS # show :: FormatFeatureFlagBits -> String # showList :: [FormatFeatureFlagBits] -> ShowS #
Eq FormatFeatureFlagBits Source #
Instance details Defined in Vulkan.Core10.Enums.FormatFeatureFlagBits Methods (==) :: FormatFeatureFlagBits -> FormatFeatureFlagBits -> Bool # (/=) :: FormatFeatureFlagBits -> FormatFeatureFlagBits -> Bool #
Ord FormatFeatureFlagBits Source #
Instance details Defined in Vulkan.Core10.Enums.FormatFeatureFlagBits Methods compare :: FormatFeatureFlagBits -> FormatFeatureFlagBits -> Ordering # (<) :: FormatFeatureFlagBits -> FormatFeatureFlagBits -> Bool # (<=) :: FormatFeatureFlagBits -> FormatFeatureFlagBits -> Bool # (>) :: FormatFeatureFlagBits -> FormatFeatureFlagBits -> Bool # (>=) :: FormatFeatureFlagBits -> FormatFeatureFlagBits -> Bool # max :: FormatFeatureFlagBits -> FormatFeatureFlagBits -> FormatFeatureFlagBits # min :: FormatFeatureFlagBits -> FormatFeatureFlagBits -> FormatFeatureFlagBits #
Zero FormatFeatureFlagBits Source #
Instance details Defined in Vulkan.Core10.Enums.FormatFeatureFlagBits Methods zero :: FormatFeatureFlagBits Source #

type FormatFeatureFlags = FormatFeatureFlagBits Source #

Storable CommandPoolTrimFlags Source #
Instance details Defined in Vulkan.Core11.Enums.CommandPoolTrimFlags Methods sizeOf :: CommandPoolTrimFlags -> Int # alignment :: CommandPoolTrimFlags -> Int # peekElemOff :: Ptr CommandPoolTrimFlags -> Int -> IO CommandPoolTrimFlags # pokeElemOff :: Ptr CommandPoolTrimFlags -> Int -> CommandPoolTrimFlags -> IO () # peekByteOff :: Ptr b -> Int -> IO CommandPoolTrimFlags # pokeByteOff :: Ptr b -> Int -> CommandPoolTrimFlags -> IO () # peek :: Ptr CommandPoolTrimFlags -> IO CommandPoolTrimFlags # poke :: Ptr CommandPoolTrimFlags -> CommandPoolTrimFlags -> IO () #
Bits CommandPoolTrimFlags Source #
Instance details Defined in Vulkan.Core11.Enums.CommandPoolTrimFlags Methods (.&.) :: CommandPoolTrimFlags -> CommandPoolTrimFlags -> CommandPoolTrimFlags # (.\|.) :: CommandPoolTrimFlags -> CommandPoolTrimFlags -> CommandPoolTrimFlags # xor :: CommandPoolTrimFlags -> CommandPoolTrimFlags -> CommandPoolTrimFlags # complement :: CommandPoolTrimFlags -> CommandPoolTrimFlags # shift :: CommandPoolTrimFlags -> Int -> CommandPoolTrimFlags # rotate :: CommandPoolTrimFlags -> Int -> CommandPoolTrimFlags # zeroBits :: CommandPoolTrimFlags # bit :: Int -> CommandPoolTrimFlags # setBit :: CommandPoolTrimFlags -> Int -> CommandPoolTrimFlags # clearBit :: CommandPoolTrimFlags -> Int -> CommandPoolTrimFlags # complementBit :: CommandPoolTrimFlags -> Int -> CommandPoolTrimFlags # testBit :: CommandPoolTrimFlags -> Int -> Bool # bitSizeMaybe :: CommandPoolTrimFlags -> Maybe Int # bitSize :: CommandPoolTrimFlags -> Int # isSigned :: CommandPoolTrimFlags -> Bool # shiftL :: CommandPoolTrimFlags -> Int -> CommandPoolTrimFlags # unsafeShiftL :: CommandPoolTrimFlags -> Int -> CommandPoolTrimFlags # shiftR :: CommandPoolTrimFlags -> Int -> CommandPoolTrimFlags # unsafeShiftR :: CommandPoolTrimFlags -> Int -> CommandPoolTrimFlags # rotateL :: CommandPoolTrimFlags -> Int -> CommandPoolTrimFlags # rotateR :: CommandPoolTrimFlags -> Int -> CommandPoolTrimFlags # popCount :: CommandPoolTrimFlags -> Int #
FiniteBits CommandPoolTrimFlags Source #
Instance details Defined in Vulkan.Core11.Enums.CommandPoolTrimFlags Methods finiteBitSize :: CommandPoolTrimFlags -> Int # countLeadingZeros :: CommandPoolTrimFlags -> Int # countTrailingZeros :: CommandPoolTrimFlags -> Int #
Read CommandPoolTrimFlags Source #
Instance details Defined in Vulkan.Core11.Enums.CommandPoolTrimFlags Methods readsPrec :: Int -> ReadS CommandPoolTrimFlags # readList :: ReadS [CommandPoolTrimFlags] # readPrec :: ReadPrec CommandPoolTrimFlags # readListPrec :: ReadPrec [CommandPoolTrimFlags] #
Show CommandPoolTrimFlags Source #
Instance details Defined in Vulkan.Core11.Enums.CommandPoolTrimFlags Methods showsPrec :: Int -> CommandPoolTrimFlags -> ShowS # show :: CommandPoolTrimFlags -> String # showList :: [CommandPoolTrimFlags] -> ShowS #
Eq CommandPoolTrimFlags Source #
Instance details Defined in Vulkan.Core11.Enums.CommandPoolTrimFlags Methods (==) :: CommandPoolTrimFlags -> CommandPoolTrimFlags -> Bool # (/=) :: CommandPoolTrimFlags -> CommandPoolTrimFlags -> Bool #
Ord CommandPoolTrimFlags Source #
Instance details Defined in Vulkan.Core11.Enums.CommandPoolTrimFlags Methods compare :: CommandPoolTrimFlags -> CommandPoolTrimFlags -> Ordering # (<) :: CommandPoolTrimFlags -> CommandPoolTrimFlags -> Bool # (<=) :: CommandPoolTrimFlags -> CommandPoolTrimFlags -> Bool # (>) :: CommandPoolTrimFlags -> CommandPoolTrimFlags -> Bool # (>=) :: CommandPoolTrimFlags -> CommandPoolTrimFlags -> Bool # max :: CommandPoolTrimFlags -> CommandPoolTrimFlags -> CommandPoolTrimFlags # min :: CommandPoolTrimFlags -> CommandPoolTrimFlags -> CommandPoolTrimFlags #
Zero CommandPoolTrimFlags Source #
Instance details Defined in Vulkan.Core11.Enums.CommandPoolTrimFlags Methods zero :: CommandPoolTrimFlags Source #

Storable Result Source #
Instance details Defined in Vulkan.Core10.Enums.Result Methods sizeOf :: Result -> Int # alignment :: Result -> Int # peekElemOff :: Ptr Result -> Int -> IO Result # pokeElemOff :: Ptr Result -> Int -> Result -> IO () # peekByteOff :: Ptr b -> Int -> IO Result # pokeByteOff :: Ptr b -> Int -> Result -> IO () # peek :: Ptr Result -> IO Result # poke :: Ptr Result -> Result -> IO () #
Read Result Source #
Instance details Defined in Vulkan.Core10.Enums.Result Methods readsPrec :: Int -> ReadS Result # readList :: ReadS [Result] # readPrec :: ReadPrec Result # readListPrec :: ReadPrec [Result] #
Show Result Source #
Instance details Defined in Vulkan.Core10.Enums.Result Methods showsPrec :: Int -> Result -> ShowS # show :: Result -> String # showList :: [Result] -> ShowS #
Eq Result Source #
Instance details Defined in Vulkan.Core10.Enums.Result Methods (==) :: Result -> Result -> Bool # (/=) :: Result -> Result -> Bool #
Ord Result Source #
Instance details Defined in Vulkan.Core10.Enums.Result Methods compare :: Result -> Result -> Ordering # (<) :: Result -> Result -> Bool # (<=) :: Result -> Result -> Bool # (>) :: Result -> Result -> Bool # (>=) :: Result -> Result -> Bool # max :: Result -> Result -> Result # min :: Result -> Result -> Result #
Zero Result Source #
Instance details Defined in Vulkan.Core10.Enums.Result Methods zero :: Result Source #

Storable ImageCreateFlagBits Source #
Instance details Defined in Vulkan.Core10.Enums.ImageCreateFlagBits Methods sizeOf :: ImageCreateFlagBits -> Int # alignment :: ImageCreateFlagBits -> Int # peekElemOff :: Ptr ImageCreateFlagBits -> Int -> IO ImageCreateFlagBits # pokeElemOff :: Ptr ImageCreateFlagBits -> Int -> ImageCreateFlagBits -> IO () # peekByteOff :: Ptr b -> Int -> IO ImageCreateFlagBits # pokeByteOff :: Ptr b -> Int -> ImageCreateFlagBits -> IO () # peek :: Ptr ImageCreateFlagBits -> IO ImageCreateFlagBits # poke :: Ptr ImageCreateFlagBits -> ImageCreateFlagBits -> IO () #
Bits ImageCreateFlagBits Source #
Instance details Defined in Vulkan.Core10.Enums.ImageCreateFlagBits Methods (.&.) :: ImageCreateFlagBits -> ImageCreateFlagBits -> ImageCreateFlagBits # (.\|.) :: ImageCreateFlagBits -> ImageCreateFlagBits -> ImageCreateFlagBits # xor :: ImageCreateFlagBits -> ImageCreateFlagBits -> ImageCreateFlagBits # complement :: ImageCreateFlagBits -> ImageCreateFlagBits # shift :: ImageCreateFlagBits -> Int -> ImageCreateFlagBits # rotate :: ImageCreateFlagBits -> Int -> ImageCreateFlagBits # zeroBits :: ImageCreateFlagBits # bit :: Int -> ImageCreateFlagBits # setBit :: ImageCreateFlagBits -> Int -> ImageCreateFlagBits # clearBit :: ImageCreateFlagBits -> Int -> ImageCreateFlagBits # complementBit :: ImageCreateFlagBits -> Int -> ImageCreateFlagBits # testBit :: ImageCreateFlagBits -> Int -> Bool # bitSizeMaybe :: ImageCreateFlagBits -> Maybe Int # bitSize :: ImageCreateFlagBits -> Int # isSigned :: ImageCreateFlagBits -> Bool # shiftL :: ImageCreateFlagBits -> Int -> ImageCreateFlagBits # unsafeShiftL :: ImageCreateFlagBits -> Int -> ImageCreateFlagBits # shiftR :: ImageCreateFlagBits -> Int -> ImageCreateFlagBits # unsafeShiftR :: ImageCreateFlagBits -> Int -> ImageCreateFlagBits # rotateL :: ImageCreateFlagBits -> Int -> ImageCreateFlagBits # rotateR :: ImageCreateFlagBits -> Int -> ImageCreateFlagBits # popCount :: ImageCreateFlagBits -> Int #
FiniteBits ImageCreateFlagBits Source #
Instance details Defined in Vulkan.Core10.Enums.ImageCreateFlagBits Methods finiteBitSize :: ImageCreateFlagBits -> Int # countLeadingZeros :: ImageCreateFlagBits -> Int # countTrailingZeros :: ImageCreateFlagBits -> Int #
Read ImageCreateFlagBits Source #
Instance details Defined in Vulkan.Core10.Enums.ImageCreateFlagBits Methods readsPrec :: Int -> ReadS ImageCreateFlagBits # readList :: ReadS [ImageCreateFlagBits] # readPrec :: ReadPrec ImageCreateFlagBits # readListPrec :: ReadPrec [ImageCreateFlagBits] #
Show ImageCreateFlagBits Source #
Instance details Defined in Vulkan.Core10.Enums.ImageCreateFlagBits Methods showsPrec :: Int -> ImageCreateFlagBits -> ShowS # show :: ImageCreateFlagBits -> String # showList :: [ImageCreateFlagBits] -> ShowS #
Eq ImageCreateFlagBits Source #
Instance details Defined in Vulkan.Core10.Enums.ImageCreateFlagBits Methods (==) :: ImageCreateFlagBits -> ImageCreateFlagBits -> Bool # (/=) :: ImageCreateFlagBits -> ImageCreateFlagBits -> Bool #
Ord ImageCreateFlagBits Source #
Instance details Defined in Vulkan.Core10.Enums.ImageCreateFlagBits Methods compare :: ImageCreateFlagBits -> ImageCreateFlagBits -> Ordering # (<) :: ImageCreateFlagBits -> ImageCreateFlagBits -> Bool # (<=) :: ImageCreateFlagBits -> ImageCreateFlagBits -> Bool # (>) :: ImageCreateFlagBits -> ImageCreateFlagBits -> Bool # (>=) :: ImageCreateFlagBits -> ImageCreateFlagBits -> Bool # max :: ImageCreateFlagBits -> ImageCreateFlagBits -> ImageCreateFlagBits # min :: ImageCreateFlagBits -> ImageCreateFlagBits -> ImageCreateFlagBits #
Zero ImageCreateFlagBits Source #
Instance details Defined in Vulkan.Core10.Enums.ImageCreateFlagBits Methods zero :: ImageCreateFlagBits Source #

Documentation

Description

Valid Usage (Implicit)

Host Synchronization

See Also

Description

See Also

Instances

Description

See Also

Instances

Description

See Also

Instances

Description

See Also

Instances

pattern SUCCESS :: Result	`SUCCESS` Command successfully completed
pattern NOT_READY :: Result	`NOT_READY` A fence or query has not yet completed
pattern TIMEOUT :: Result	`TIMEOUT` A wait operation has not completed in the specified time
pattern EVENT_SET :: Result	`EVENT_SET` An event is signaled
pattern EVENT_RESET :: Result	`EVENT_RESET` An event is unsignaled
pattern INCOMPLETE :: Result	`INCOMPLETE` A return array was too small for the result
pattern ERROR_OUT_OF_HOST_MEMORY :: Result	`ERROR_OUT_OF_HOST_MEMORY` A host memory allocation has failed.
pattern ERROR_OUT_OF_DEVICE_MEMORY :: Result	`ERROR_OUT_OF_DEVICE_MEMORY` A device memory allocation has failed.
pattern ERROR_INITIALIZATION_FAILED :: Result	`ERROR_INITIALIZATION_FAILED` Initialization of an object could not be completed for implementation-specific reasons.
pattern ERROR_DEVICE_LOST :: Result	`ERROR_DEVICE_LOST` The logical or physical device has been lost. See Lost Device
pattern ERROR_MEMORY_MAP_FAILED :: Result	`ERROR_MEMORY_MAP_FAILED` Mapping of a memory object has failed.
pattern ERROR_LAYER_NOT_PRESENT :: Result	`ERROR_LAYER_NOT_PRESENT` A requested layer is not present or could not be loaded.
pattern ERROR_EXTENSION_NOT_PRESENT :: Result	`ERROR_EXTENSION_NOT_PRESENT` A requested extension is not supported.
pattern ERROR_FEATURE_NOT_PRESENT :: Result	`ERROR_FEATURE_NOT_PRESENT` A requested feature is not supported.
pattern ERROR_INCOMPATIBLE_DRIVER :: Result	`ERROR_INCOMPATIBLE_DRIVER` The requested version of Vulkan is not supported by the driver or is otherwise incompatible for implementation-specific reasons.
pattern ERROR_TOO_MANY_OBJECTS :: Result	`ERROR_TOO_MANY_OBJECTS` Too many objects of the type have already been created.
pattern ERROR_FORMAT_NOT_SUPPORTED :: Result	`ERROR_FORMAT_NOT_SUPPORTED` A requested format is not supported on this device.
pattern ERROR_FRAGMENTED_POOL :: Result	`ERROR_FRAGMENTED_POOL` A pool allocation has failed due to fragmentation of the pool’s memory. This must only be returned if no attempt to allocate host or device memory was made to accommodate the new allocation. This should be returned in preference to `ERROR_OUT_OF_POOL_MEMORY`, but only if the implementation is certain that the pool allocation failure was due to fragmentation.
pattern ERROR_UNKNOWN :: Result	`ERROR_UNKNOWN` An unknown error has occurred; either the application has provided invalid input, or an implementation failure has occurred.
pattern ERROR_INCOMPATIBLE_SHADER_BINARY_EXT :: Result	`ERROR_INCOMPATIBLE_SHADER_BINARY_EXT` The provided binary shader code is not compatible with this device.
pattern ERROR_COMPRESSION_EXHAUSTED_EXT :: Result	`ERROR_COMPRESSION_EXHAUSTED_EXT` An image creation failed because internal resources required for compression are exhausted. This must only be returned when fixed-rate compression is requested.
pattern OPERATION_NOT_DEFERRED_KHR :: Result	`OPERATION_NOT_DEFERRED_KHR` A deferred operation was requested and no operations were deferred.
pattern OPERATION_DEFERRED_KHR :: Result	`OPERATION_DEFERRED_KHR` A deferred operation was requested and at least some of the work was deferred.
pattern THREAD_DONE_KHR :: Result	`THREAD_DONE_KHR` A deferred operation is not complete but there is no work remaining to assign to additional threads.
pattern THREAD_IDLE_KHR :: Result	`THREAD_IDLE_KHR` A deferred operation is not complete but there is currently no work for this thread to do at the time of this call.
pattern ERROR_FULL_SCREEN_EXCLUSIVE_MODE_LOST_EXT :: Result	`ERROR_FULL_SCREEN_EXCLUSIVE_MODE_LOST_EXT` An operation on a swapchain created with `FULL_SCREEN_EXCLUSIVE_APPLICATION_CONTROLLED_EXT` failed as it did not have exclusive full-screen access. This may occur due to implementation-dependent reasons, outside of the application’s control.
pattern ERROR_NOT_PERMITTED_KHR :: Result
pattern ERROR_INVALID_DRM_FORMAT_MODIFIER_PLANE_LAYOUT_EXT :: Result
pattern ERROR_INVALID_SHADER_NV :: Result	`ERROR_INVALID_SHADER_NV` One or more shaders failed to compile or link. More details are reported back to the application via `VK_EXT_debug_report` if enabled.
pattern ERROR_VALIDATION_FAILED_EXT :: Result	`ERROR_VALIDATION_FAILED_EXT` A command failed because invalid usage was detected by the implementation or a validation-layer.
pattern ERROR_INCOMPATIBLE_DISPLAY_KHR :: Result	`ERROR_INCOMPATIBLE_DISPLAY_KHR` The display used by a swapchain does not use the same presentable image layout, or is incompatible in a way that prevents sharing an image.
pattern ERROR_OUT_OF_DATE_KHR :: Result	`ERROR_OUT_OF_DATE_KHR` A surface has changed in such a way that it is no longer compatible with the swapchain, and further presentation requests using the swapchain will fail. Applications must query the new surface properties and recreate their swapchain if they wish to continue presenting to the surface.
pattern SUBOPTIMAL_KHR :: Result	`SUBOPTIMAL_KHR` A swapchain no longer matches the surface properties exactly, but can still be used to present to the surface successfully.
pattern ERROR_NATIVE_WINDOW_IN_USE_KHR :: Result	`ERROR_NATIVE_WINDOW_IN_USE_KHR` The requested window is already in use by Vulkan or another API in a manner which prevents it from being used again.
pattern ERROR_SURFACE_LOST_KHR :: Result	`ERROR_SURFACE_LOST_KHR` A surface is no longer available.
pattern ERROR_NO_PIPELINE_MATCH :: Result
pattern ERROR_INVALID_PIPELINE_CACHE_DATA :: Result
pattern ERROR_VALIDATION_FAILED :: Result
pattern PIPELINE_COMPILE_REQUIRED :: Result	`PIPELINE_COMPILE_REQUIRED` A requested pipeline creation would have required compilation, but the application requested compilation to not be performed.
pattern ERROR_INVALID_OPAQUE_CAPTURE_ADDRESS :: Result	`ERROR_INVALID_OPAQUE_CAPTURE_ADDRESS` A buffer creation or memory allocation failed because the requested address is not available. A shader group handle assignment failed because the requested shader group handle information is no longer valid.
pattern ERROR_FRAGMENTATION :: Result	`ERROR_FRAGMENTATION` A descriptor pool creation has failed due to fragmentation.
pattern ERROR_INVALID_EXTERNAL_HANDLE :: Result	`ERROR_INVALID_EXTERNAL_HANDLE` An external handle is not a valid handle of the specified type.
pattern ERROR_OUT_OF_POOL_MEMORY :: Result	`ERROR_OUT_OF_POOL_MEMORY` A pool memory allocation has failed. This must only be returned if no attempt to allocate host or device memory was made to accommodate the new allocation. If the failure was definitely due to fragmentation of the pool, `ERROR_FRAGMENTED_POOL` should be returned instead.

pattern IMAGE_CREATE_SPARSE_BINDING_BIT :: ImageCreateFlagBits	`IMAGE_CREATE_SPARSE_BINDING_BIT` specifies that the image will be backed using sparse memory binding.
pattern IMAGE_CREATE_SPARSE_RESIDENCY_BIT :: ImageCreateFlagBits	`IMAGE_CREATE_SPARSE_RESIDENCY_BIT` specifies that the image can be partially backed using sparse memory binding. Images created with this flag must also be created with the `IMAGE_CREATE_SPARSE_BINDING_BIT` flag.
pattern IMAGE_CREATE_SPARSE_ALIASED_BIT :: ImageCreateFlagBits	`IMAGE_CREATE_SPARSE_ALIASED_BIT` specifies that the image will be backed using sparse memory binding with memory ranges that might also simultaneously be backing another image (or another portion of the same image). Images created with this flag must also be created with the `IMAGE_CREATE_SPARSE_BINDING_BIT` flag.
pattern IMAGE_CREATE_MUTABLE_FORMAT_BIT :: ImageCreateFlagBits	`IMAGE_CREATE_MUTABLE_FORMAT_BIT` specifies that the image can be used to create a `ImageView` with a different format from the image. For multi-planar formats, `IMAGE_CREATE_MUTABLE_FORMAT_BIT` specifies that a `ImageView` can be created of a plane of the image.
pattern IMAGE_CREATE_CUBE_COMPATIBLE_BIT :: ImageCreateFlagBits	`IMAGE_CREATE_CUBE_COMPATIBLE_BIT` specifies that the image can be used to create a `ImageView` of type `IMAGE_VIEW_TYPE_CUBE` or `IMAGE_VIEW_TYPE_CUBE_ARRAY`.
pattern IMAGE_CREATE_FRAGMENT_DENSITY_MAP_OFFSET_BIT_QCOM :: ImageCreateFlagBits	`IMAGE_CREATE_FRAGMENT_DENSITY_MAP_OFFSET_BIT_QCOM` specifies that an image can be used in a render pass with non-zero fragment density map offsets. In a render pass with non-zero offsets, fragment density map attachments, input attachments, color attachments, depth/stencil attachment, resolve attachments, and preserve attachments must be created with `IMAGE_CREATE_FRAGMENT_DENSITY_MAP_OFFSET_BIT_QCOM`.
pattern IMAGE_CREATE_2D_VIEW_COMPATIBLE_BIT_EXT :: ImageCreateFlagBits	`IMAGE_CREATE_2D_VIEW_COMPATIBLE_BIT_EXT` specifies that the image can be used to create a `ImageView` of type `IMAGE_VIEW_TYPE_2D`.
pattern IMAGE_CREATE_MULTISAMPLED_RENDER_TO_SINGLE_SAMPLED_BIT_EXT :: ImageCreateFlagBits	`IMAGE_CREATE_MULTISAMPLED_RENDER_TO_SINGLE_SAMPLED_BIT_EXT` specifies that an image can be used with multisampled rendering as a single-sampled framebuffer attachment
pattern IMAGE_CREATE_DESCRIPTOR_BUFFER_CAPTURE_REPLAY_BIT_EXT :: ImageCreateFlagBits	`IMAGE_CREATE_DESCRIPTOR_BUFFER_CAPTURE_REPLAY_BIT_EXT` specifies that the image can be used with descriptor buffers when capturing and replaying (e.g. for trace capture and replay), see `OpaqueCaptureDescriptorDataCreateInfoEXT` for more detail.
pattern IMAGE_CREATE_SUBSAMPLED_BIT_EXT :: ImageCreateFlagBits	`IMAGE_CREATE_SUBSAMPLED_BIT_EXT` specifies that an image can be in a subsampled format which may be more optimal when written as an attachment by a render pass that has a fragment density map attachment. Accessing a subsampled image has additional considerations: Image data read as an image sampler will have undefined values if the sampler was not created with `flags` containing `SAMPLER_CREATE_SUBSAMPLED_BIT_EXT` or was not sampled through the use of a combined image sampler with an immutable sampler in `DescriptorSetLayoutBinding`. Image data read with an input attachment will have undefined values if the contents were not written as an attachment in an earlier subpass of the same render pass. Image data read as an image sampler in the fragment shader will be additionally be read by the device during `PIPELINE_STAGE_VERTEX_SHADER_BIT` if ::subsampledCoarseReconstructionEarlyAccess is `TRUE` and the sampler was created with `flags` containing `SAMPLER_CREATE_SUBSAMPLED_COARSE_RECONSTRUCTION_BIT_EXT`. Image data read with load operations are resampled to the fragment density of the render pass if ::subsampledLoads is `TRUE`. Otherwise, values of image data are undefined. Image contents outside of the render area take on undefined values if the image is stored as a render pass attachment.
pattern IMAGE_CREATE_SAMPLE_LOCATIONS_COMPATIBLE_DEPTH_BIT_EXT :: ImageCreateFlagBits	`IMAGE_CREATE_SAMPLE_LOCATIONS_COMPATIBLE_DEPTH_BIT_EXT` specifies that an image with a depth or depth/stencil format can be used with custom sample locations when used as a depth/stencil attachment.
pattern IMAGE_CREATE_CORNER_SAMPLED_BIT_NV :: ImageCreateFlagBits	`IMAGE_CREATE_CORNER_SAMPLED_BIT_NV` specifies that the image is a corner-sampled image.
pattern IMAGE_CREATE_DISJOINT_BIT :: ImageCreateFlagBits	`IMAGE_CREATE_DISJOINT_BIT` specifies that an image with a multi-planar format must have each plane separately bound to memory, rather than having a single memory binding for the whole image; the presence of this bit distinguishes a disjoint image from an image without this bit set.
pattern IMAGE_CREATE_PROTECTED_BIT :: ImageCreateFlagBits	`IMAGE_CREATE_PROTECTED_BIT` specifies that the image is a protected image.
pattern IMAGE_CREATE_EXTENDED_USAGE_BIT :: ImageCreateFlagBits	`IMAGE_CREATE_EXTENDED_USAGE_BIT` specifies that the image can be created with usage flags that are not supported for the format the image is created with but are supported for at least one format a `ImageView` created from the image can have.
pattern IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT :: ImageCreateFlagBits	`IMAGE_CREATE_BLOCK_TEXEL_VIEW_COMPATIBLE_BIT` specifies that the image having a compressed format can be used to create a `ImageView` with an uncompressed format where each texel in the image view corresponds to a compressed texel block of the image.
pattern IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT :: ImageCreateFlagBits	`IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT` specifies that the image can be used to create a `ImageView` of type `IMAGE_VIEW_TYPE_2D` or `IMAGE_VIEW_TYPE_2D_ARRAY`.
pattern IMAGE_CREATE_SPLIT_INSTANCE_BIND_REGIONS_BIT :: ImageCreateFlagBits	`IMAGE_CREATE_SPLIT_INSTANCE_BIND_REGIONS_BIT` specifies that the image can be used with a non-zero value of the `splitInstanceBindRegionCount` member of a `BindImageMemoryDeviceGroupInfo` structure passed into `bindImageMemory2`. This flag also has the effect of making the image use the standard sparse image block dimensions.
pattern IMAGE_CREATE_ALIAS_BIT :: ImageCreateFlagBits	`IMAGE_CREATE_ALIAS_BIT` specifies that two images created with the same creation parameters and aliased to the same memory can interpret the contents of the memory consistently with each other, subject to the rules described in the Memory Aliasing section. This flag further specifies that each plane of a disjoint image can share an in-memory non-linear representation with single-plane images, and that a single-plane image can share an in-memory non-linear representation with a plane of a multi-planar disjoint image, according to the rules in https://registry.khronos.org/vulkan/specs/1.3-extensions/html/vkspec.html#formats-compatible-planes. If the `pNext` chain includes a `ExternalMemoryImageCreateInfo` or `ExternalMemoryImageCreateInfoNV` structure whose `handleTypes` member is not `0`, it is as if `IMAGE_CREATE_ALIAS_BIT` is set.