vulkan-3.8.1: Bindings to the Vulkan graphics API.
Safe HaskellNone
LanguageHaskell2010

Vulkan.Core10.Pass

Synopsis

Documentation

createFramebuffer Source #

Arguments

:: forall a io. (Extendss FramebufferCreateInfo a, PokeChain a, MonadIO io) 
=> Device

device is the logical device that creates the framebuffer.

-> FramebufferCreateInfo a

pCreateInfo is a pointer to a FramebufferCreateInfo structure describing additional information about framebuffer creation.

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

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

-> io Framebuffer 

vkCreateFramebuffer - Create a new framebuffer object

Valid Usage

  • If pCreateInfo->flags does not include FRAMEBUFFER_CREATE_IMAGELESS_BIT, and attachmentCount is not 0, each element of pCreateInfo->pAttachments must have been created on device

Valid Usage (Implicit)

  • device must be a valid Device handle

Return Codes

Success
Failure

See Also

AllocationCallbacks, Device, Framebuffer, FramebufferCreateInfo

withFramebuffer :: forall a io r. (Extendss FramebufferCreateInfo a, PokeChain a, MonadIO io) => Device -> FramebufferCreateInfo a -> Maybe AllocationCallbacks -> (io Framebuffer -> (Framebuffer -> io ()) -> r) -> r Source #

A convenience wrapper to make a compatible pair of calls to createFramebuffer and destroyFramebuffer

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

destroyFramebuffer Source #

Arguments

:: forall io. MonadIO io 
=> Device

device is the logical device that destroys the framebuffer.

-> Framebuffer

framebuffer is the handle of the framebuffer to destroy.

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

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

-> io () 

vkDestroyFramebuffer - Destroy a framebuffer object

Valid Usage

  • All submitted commands that refer to framebuffer must have completed execution
  • If AllocationCallbacks were provided when framebuffer was created, a compatible set of callbacks must be provided here
  • If no AllocationCallbacks were provided when framebuffer was created, pAllocator must be NULL

Valid Usage (Implicit)

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

Host Synchronization

  • Host access to framebuffer must be externally synchronized

See Also

AllocationCallbacks, Device, Framebuffer

createRenderPass Source #

Arguments

:: forall a io. (Extendss RenderPassCreateInfo a, PokeChain a, MonadIO io) 
=> Device

device is the logical device that creates the render pass.

-> RenderPassCreateInfo a

pCreateInfo is a pointer to a RenderPassCreateInfo structure describing the parameters of the render pass.

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

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

-> io RenderPass 

vkCreateRenderPass - Create a new render pass object

Valid Usage (Implicit)

  • device must be a valid Device handle

Return Codes

Success
Failure

See Also

AllocationCallbacks, Device, RenderPass, RenderPassCreateInfo

withRenderPass :: forall a io r. (Extendss RenderPassCreateInfo a, PokeChain a, MonadIO io) => Device -> RenderPassCreateInfo a -> Maybe AllocationCallbacks -> (io RenderPass -> (RenderPass -> io ()) -> r) -> r Source #

A convenience wrapper to make a compatible pair of calls to createRenderPass and destroyRenderPass

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

destroyRenderPass Source #

Arguments

:: forall io. MonadIO io 
=> Device

device is the logical device that destroys the render pass.

-> RenderPass

renderPass is the handle of the render pass to destroy.

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

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

-> io () 

vkDestroyRenderPass - Destroy a render pass object

Valid Usage

  • All submitted commands that refer to renderPass must have completed execution
  • If AllocationCallbacks were provided when renderPass was created, a compatible set of callbacks must be provided here
  • If no AllocationCallbacks were provided when renderPass was created, pAllocator must be NULL

Valid Usage (Implicit)

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

Host Synchronization

  • Host access to renderPass must be externally synchronized

See Also

AllocationCallbacks, Device, RenderPass

getRenderAreaGranularity Source #

Arguments

:: forall io. MonadIO io 
=> Device

device is the logical device that owns the render pass.

-> RenderPass

renderPass is a handle to a render pass.

-> io ("granularity" ::: Extent2D) 

vkGetRenderAreaGranularity - Returns the granularity for optimal render area

Description

The conditions leading to an optimal renderArea are:

  • the offset.x member in renderArea is a multiple of the width member of the returned Extent2D (the horizontal granularity).
  • the offset.y member in renderArea is a multiple of the height of the returned Extent2D (the vertical granularity).
  • either the offset.width member in renderArea is a multiple of the horizontal granularity or offset.x+offset.width is equal to the width of the framebuffer in the RenderPassBeginInfo.
  • either the offset.height member in renderArea is a multiple of the vertical granularity or offset.y+offset.height is equal to the height of the framebuffer in the RenderPassBeginInfo.

Subpass dependencies are not affected by the render area, and apply to the entire image subresources attached to the framebuffer as specified in the description of automatic layout transitions. Similarly, pipeline barriers are valid even if their effect extends outside the render area.

Valid Usage (Implicit)

  • device must be a valid Device handle
  • renderPass must be a valid RenderPass handle
  • pGranularity must be a valid pointer to a Extent2D structure
  • renderPass must have been created, allocated, or retrieved from device

See Also

Device, Extent2D, RenderPass

data AttachmentDescription Source #

VkAttachmentDescription - Structure specifying an attachment description

Description

If the attachment uses a color format, then loadOp and storeOp are used, and stencilLoadOp and stencilStoreOp are ignored. If the format has depth and/or stencil components, loadOp and storeOp apply only to the depth data, while stencilLoadOp and stencilStoreOp define how the stencil data is handled. loadOp and stencilLoadOp define the load operations that execute as part of the first subpass that uses the attachment. storeOp and stencilStoreOp define the store operations that execute as part of the last subpass that uses the attachment.

The load operation for each sample in an attachment happens-before any recorded command which accesses the sample in the first subpass where the attachment is used. Load operations for attachments with a depth/stencil format execute in the PIPELINE_STAGE_EARLY_FRAGMENT_TESTS_BIT pipeline stage. Load operations for attachments with a color format execute in the PIPELINE_STAGE_COLOR_ATTACHMENT_OUTPUT_BIT pipeline stage.

The store operation for each sample in an attachment happens-after any recorded command which accesses the sample in the last subpass where the attachment is used. Store operations for attachments with a depth/stencil format execute in the PIPELINE_STAGE_LATE_FRAGMENT_TESTS_BIT pipeline stage. Store operations for attachments with a color format execute in the PIPELINE_STAGE_COLOR_ATTACHMENT_OUTPUT_BIT pipeline stage.

If an attachment is not used by any subpass, then loadOp, storeOp, stencilStoreOp, and stencilLoadOp are ignored, and the attachment’s memory contents will not be modified by execution of a render pass instance.

The load and store operations apply on the first and last use of each view in the render pass, respectively. If a view index of an attachment is not included in the view mask in any subpass that uses it, then the load and store operations are ignored, and the attachment’s memory contents will not be modified by execution of a render pass instance.

During a render pass instance, input/color attachments with color formats that have a component size of 8, 16, or 32 bits must be represented in the attachment’s format throughout the instance. Attachments with other floating- or fixed-point color formats, or with depth components may be represented in a format with a precision higher than the attachment format, but must be represented with the same range. When such a component is loaded via the loadOp, it will be converted into an implementation-dependent format used by the render pass. Such components must be converted from the render pass format, to the format of the attachment, before they are resolved or stored at the end of a render pass instance via storeOp. Conversions occur as described in Numeric Representation and Computation and Fixed-Point Data Conversions.

If flags includes ATTACHMENT_DESCRIPTION_MAY_ALIAS_BIT, then the attachment is treated as if it shares physical memory with another attachment in the same render pass. This information limits the ability of the implementation to reorder certain operations (like layout transitions and the loadOp) such that it is not improperly reordered against other uses of the same physical memory via a different attachment. This is described in more detail below.

If a render pass uses multiple attachments that alias the same device memory, those attachments must each include the ATTACHMENT_DESCRIPTION_MAY_ALIAS_BIT bit in their attachment description flags. Attachments aliasing the same memory occurs in multiple ways:

  • Multiple attachments being assigned the same image view as part of framebuffer creation.
  • Attachments using distinct image views that correspond to the same image subresource of an image.
  • Attachments using views of distinct image subresources which are bound to overlapping memory ranges.

Note

Render passes must include subpass dependencies (either directly or via a subpass dependency chain) between any two subpasses that operate on the same attachment or aliasing attachments and those subpass dependencies must include execution and memory dependencies separating uses of the aliases, if at least one of those subpasses writes to one of the aliases. These dependencies must not include the DEPENDENCY_BY_REGION_BIT if the aliases are views of distinct image subresources which overlap in memory.

Multiple attachments that alias the same memory must not be used in a single subpass. A given attachment index must not be used multiple times in a single subpass, with one exception: two subpass attachments can use the same attachment index if at least one use is as an input attachment and neither use is as a resolve or preserve attachment. In other words, the same view can be used simultaneously as an input and color or depth/stencil attachment, but must not be used as multiple color or depth/stencil attachments nor as resolve or preserve attachments. The precise set of valid scenarios is described in more detail below.

If a set of attachments alias each other, then all except the first to be used in the render pass must use an initialLayout of IMAGE_LAYOUT_UNDEFINED, since the earlier uses of the other aliases make their contents undefined. Once an alias has been used and a different alias has been used after it, the first alias must not be used in any later subpasses. However, an application can assign the same image view to multiple aliasing attachment indices, which allows that image view to be used multiple times even if other aliases are used in between.

Note

Once an attachment needs the ATTACHMENT_DESCRIPTION_MAY_ALIAS_BIT bit, there should be no additional cost of introducing additional aliases, and using these additional aliases may allow more efficient clearing of the attachments on multiple uses via ATTACHMENT_LOAD_OP_CLEAR.

Valid Usage

Valid Usage (Implicit)

See Also

AttachmentDescriptionFlags, AttachmentLoadOp, AttachmentStoreOp, Format, ImageLayout, RenderPassCreateInfo, SampleCountFlagBits

Constructors

AttachmentDescription 

Fields

Instances

Instances details
Eq AttachmentDescription Source # 
Instance details

Defined in Vulkan.Core10.Pass

Show AttachmentDescription Source # 
Instance details

Defined in Vulkan.Core10.Pass

Storable AttachmentDescription Source # 
Instance details

Defined in Vulkan.Core10.Pass

FromCStruct AttachmentDescription Source # 
Instance details

Defined in Vulkan.Core10.Pass

ToCStruct AttachmentDescription Source # 
Instance details

Defined in Vulkan.Core10.Pass

Zero AttachmentDescription Source # 
Instance details

Defined in Vulkan.Core10.Pass

data AttachmentReference Source #

Constructors

AttachmentReference 

Fields

Instances

Instances details
Eq AttachmentReference Source # 
Instance details

Defined in Vulkan.Core10.Pass

Show AttachmentReference Source # 
Instance details

Defined in Vulkan.Core10.Pass

Storable AttachmentReference Source # 
Instance details

Defined in Vulkan.Core10.Pass

FromCStruct AttachmentReference Source # 
Instance details

Defined in Vulkan.Core10.Pass

ToCStruct AttachmentReference Source # 
Instance details

Defined in Vulkan.Core10.Pass

Zero AttachmentReference Source # 
Instance details

Defined in Vulkan.Core10.Pass

data SubpassDescription Source #

VkSubpassDescription - Structure specifying a subpass description

Description

Each element of the pInputAttachments array corresponds to an input attachment index in a fragment shader, i.e. if a shader declares an image variable decorated with a InputAttachmentIndex value of X, then it uses the attachment provided in pInputAttachments[X]. Input attachments must also be bound to the pipeline in a descriptor set. If the attachment member of any element of pInputAttachments is ATTACHMENT_UNUSED, the application must not read from the corresponding input attachment index. Fragment shaders can use subpass input variables to access the contents of an input attachment at the fragment’s (x, y, layer) framebuffer coordinates. Input attachments must not be used by any subpasses within a renderpass that enables render pass transform.

Each element of the pColorAttachments array corresponds to an output location in the shader, i.e. if the shader declares an output variable decorated with a Location value of X, then it uses the attachment provided in pColorAttachments[X]. If the attachment member of any element of pColorAttachments is ATTACHMENT_UNUSED, writes to the corresponding location by a fragment are discarded.

If flags does not include SUBPASS_DESCRIPTION_SHADER_RESOLVE_BIT_QCOM, and if pResolveAttachments is not NULL, each of its elements corresponds to a color attachment (the element in pColorAttachments at the same index), and a multisample resolve operation is defined for each attachment. At the end of each subpass, multisample resolve operations read the subpass’s color attachments, and resolve the samples for each pixel within the render area to the same pixel location in the corresponding resolve attachments, unless the resolve attachment index is ATTACHMENT_UNUSED.

Similarly, if flags does not include SUBPASS_DESCRIPTION_SHADER_RESOLVE_BIT_QCOM, and SubpassDescriptionDepthStencilResolve::pDepthStencilResolveAttachment is not NULL and does not have the value ATTACHMENT_UNUSED, it corresponds to the depth/stencil attachment in pDepthStencilAttachment, and multisample resolve operations for depth and stencil are defined by SubpassDescriptionDepthStencilResolve::depthResolveMode and SubpassDescriptionDepthStencilResolve::stencilResolveMode, respectively. At the end of each subpass, multisample resolve operations read the subpass’s depth/stencil attachment, and resolve the samples for each pixel to the same pixel location in the corresponding resolve attachment. If SubpassDescriptionDepthStencilResolve::depthResolveMode is RESOLVE_MODE_NONE, then the depth component of the resolve attachment is not written to and its contents are preserved. Similarly, if SubpassDescriptionDepthStencilResolve::stencilResolveMode is RESOLVE_MODE_NONE, then the stencil component of the resolve attachment is not written to and its contents are preserved. SubpassDescriptionDepthStencilResolve::depthResolveMode is ignored if the Format of the pDepthStencilResolveAttachment does not have a depth component. Similarly, SubpassDescriptionDepthStencilResolve::stencilResolveMode is ignored if the Format of the pDepthStencilResolveAttachment does not have a stencil component.

If the image subresource range referenced by the depth/stencil attachment is created with IMAGE_CREATE_SAMPLE_LOCATIONS_COMPATIBLE_DEPTH_BIT_EXT, then the multisample resolve operation uses the sample locations state specified in the sampleLocationsInfo member of the element of the RenderPassSampleLocationsBeginInfoEXT::pPostSubpassSampleLocations for the subpass.

If pDepthStencilAttachment is NULL, or if its attachment index is ATTACHMENT_UNUSED, it indicates that no depth/stencil attachment will be used in the subpass.

The contents of an attachment within the render area become undefined at the start of a subpass S if all of the following conditions are true:

  • The attachment is used as a color, depth/stencil, or resolve attachment in any subpass in the render pass.
  • There is a subpass S1 that uses or preserves the attachment, and a subpass dependency from S1 to S.
  • The attachment is not used or preserved in subpass S.

In addition, the contents of an attachment within the render area become undefined at the start of a subpass S if all of the following conditions are true:

Once the contents of an attachment become undefined in subpass S, they remain undefined for subpasses in subpass dependency chains starting with subpass S until they are written again. However, they remain valid for subpasses in other subpass dependency chains starting with subpass S1 if those subpasses use or preserve the attachment.

Valid Usage

Valid Usage (Implicit)

  • pipelineBindPoint must be a valid PipelineBindPoint value
  • If inputAttachmentCount is not 0, pInputAttachments must be a valid pointer to an array of inputAttachmentCount valid AttachmentReference structures
  • If colorAttachmentCount is not 0, pColorAttachments must be a valid pointer to an array of colorAttachmentCount valid AttachmentReference structures
  • If colorAttachmentCount is not 0, and pResolveAttachments is not NULL, pResolveAttachments must be a valid pointer to an array of colorAttachmentCount valid AttachmentReference structures
  • If pDepthStencilAttachment is not NULL, pDepthStencilAttachment must be a valid pointer to a valid AttachmentReference structure
  • If preserveAttachmentCount is not 0, pPreserveAttachments must be a valid pointer to an array of preserveAttachmentCount uint32_t values

See Also

AttachmentReference, PipelineBindPoint, RenderPassCreateInfo, SubpassDescriptionFlags

Constructors

SubpassDescription 

Fields

data SubpassDependency Source #

VkSubpassDependency - Structure specifying a subpass dependency

Description

If srcSubpass is equal to dstSubpass then the SubpassDependency describes a subpass self-dependency, and only constrains the pipeline barriers allowed within a subpass instance. Otherwise, when a render pass instance which includes a subpass dependency is submitted to a queue, it defines a memory dependency between the subpasses identified by srcSubpass and dstSubpass.

If srcSubpass is equal to SUBPASS_EXTERNAL, the first synchronization scope includes commands that occur earlier in submission order than the cmdBeginRenderPass used to begin the render pass instance. Otherwise, the first set of commands includes all commands submitted as part of the subpass instance identified by srcSubpass and any load, store or multisample resolve operations on attachments used in srcSubpass. In either case, the first synchronization scope is limited to operations on the pipeline stages determined by the source stage mask specified by srcStageMask.

If dstSubpass is equal to SUBPASS_EXTERNAL, the second synchronization scope includes commands that occur later in submission order than the cmdEndRenderPass used to end the render pass instance. Otherwise, the second set of commands includes all commands submitted as part of the subpass instance identified by dstSubpass and any load, store or multisample resolve operations on attachments used in dstSubpass. In either case, the second synchronization scope is limited to operations on the pipeline stages determined by the destination stage mask specified by dstStageMask.

The first access scope is limited to access in the pipeline stages determined by the source stage mask specified by srcStageMask. It is also limited to access types in the source access mask specified by srcAccessMask.

The second access scope is limited to access in the pipeline stages determined by the destination stage mask specified by dstStageMask. It is also limited to access types in the destination access mask specified by dstAccessMask.

The availability and visibility operations defined by a subpass dependency affect the execution of image layout transitions within the render pass.

Note

For non-attachment resources, the memory dependency expressed by subpass dependency is nearly identical to that of a MemoryBarrier (with matching srcAccessMask and dstAccessMask parameters) submitted as a part of a cmdPipelineBarrier (with matching srcStageMask and dstStageMask parameters). The only difference being that its scopes are limited to the identified subpasses rather than potentially affecting everything before and after.

For attachments however, subpass dependencies work more like a ImageMemoryBarrier defined similarly to the MemoryBarrier above, the queue family indices set to QUEUE_FAMILY_IGNORED, and layouts as follows:

  • The equivalent to oldLayout is the attachment’s layout according to the subpass description for srcSubpass.
  • The equivalent to newLayout is the attachment’s layout according to the subpass description for dstSubpass.

Valid Usage

Valid Usage (Implicit)

See Also

AccessFlags, DependencyFlags, PipelineStageFlags, RenderPassCreateInfo

Constructors

SubpassDependency 

Fields

Instances

Instances details
Eq SubpassDependency Source # 
Instance details

Defined in Vulkan.Core10.Pass

Show SubpassDependency Source # 
Instance details

Defined in Vulkan.Core10.Pass

Storable SubpassDependency Source # 
Instance details

Defined in Vulkan.Core10.Pass

FromCStruct SubpassDependency Source # 
Instance details

Defined in Vulkan.Core10.Pass

ToCStruct SubpassDependency Source # 
Instance details

Defined in Vulkan.Core10.Pass

Zero SubpassDependency Source # 
Instance details

Defined in Vulkan.Core10.Pass

data RenderPassCreateInfo (es :: [Type]) Source #

VkRenderPassCreateInfo - Structure specifying parameters of a newly created render pass

Description

Note

Care should be taken to avoid a data race here; if any subpasses access attachments with overlapping memory locations, and one of those accesses is a write, a subpass dependency needs to be included between them.

Valid Usage

  • If the attachment member of any element of pInputAttachments, pColorAttachments, pResolveAttachments or pDepthStencilAttachment, or any element of pPreserveAttachments in any element of pSubpasses is not ATTACHMENT_UNUSED, it must be less than attachmentCount

Valid Usage (Implicit)

See Also

AttachmentDescription, RenderPassCreateFlags, StructureType, SubpassDependency, SubpassDescription, createRenderPass

Constructors

RenderPassCreateInfo 

Fields

Instances

Instances details
Extensible RenderPassCreateInfo Source # 
Instance details

Defined in Vulkan.Core10.Pass

Methods

extensibleTypeName :: String Source #

getNext :: forall (es :: [Type]). RenderPassCreateInfo es -> Chain es Source #

setNext :: forall (ds :: [Type]) (es :: [Type]). RenderPassCreateInfo ds -> Chain es -> RenderPassCreateInfo es Source #

extends :: forall e b proxy. Typeable e => proxy e -> (Extends RenderPassCreateInfo e => b) -> Maybe b Source #

Show (Chain es) => Show (RenderPassCreateInfo es) Source # 
Instance details

Defined in Vulkan.Core10.Pass

(Extendss RenderPassCreateInfo es, PeekChain es) => FromCStruct (RenderPassCreateInfo es) Source # 
Instance details

Defined in Vulkan.Core10.Pass

(Extendss RenderPassCreateInfo es, PokeChain es) => ToCStruct (RenderPassCreateInfo es) Source # 
Instance details

Defined in Vulkan.Core10.Pass

es ~ ('[] :: [Type]) => Zero (RenderPassCreateInfo es) Source # 
Instance details

Defined in Vulkan.Core10.Pass

data FramebufferCreateInfo (es :: [Type]) Source #

VkFramebufferCreateInfo - Structure specifying parameters of a newly created framebuffer

Description

Other than the exceptions listed below, applications must ensure that all accesses to memory that backs image subresources used as attachments in a given renderpass instance either happen-before the load operations for those attachments, or happen-after the store operations for those attachments.

The exceptions to the general rule are:

Use of non-attachment aspects in these cases is only well defined if the attachment is used in the subpass where the non-attachment access is being made, or the layout of the image subresource is constant throughout the entire render pass instance, including the initialLayout and finalLayout.

Note

These restrictions mean that the render pass has full knowledge of all uses of all of the attachments, so that the implementation is able to make correct decisions about when and how to perform layout transitions, when to overlap execution of subpasses, etc.

It is legal for a subpass to use no color or depth/stencil attachments, either because it has no attachment references or because all of them are ATTACHMENT_UNUSED. This kind of subpass can use shader side effects such as image stores and atomics to produce an output. In this case, the subpass continues to use the width, height, and layers of the framebuffer to define the dimensions of the rendering area, and the rasterizationSamples from each pipeline’s PipelineMultisampleStateCreateInfo to define the number of samples used in rasterization; however, if PhysicalDeviceFeatures::variableMultisampleRate is FALSE, then all pipelines to be bound with the subpass must have the same value for PipelineMultisampleStateCreateInfo::rasterizationSamples.

Valid Usage

  • attachmentCount must be equal to the attachment count specified in renderPass
  • If flags does not include FRAMEBUFFER_CREATE_IMAGELESS_BIT, and attachmentCount is not 0, pAttachments must be a valid pointer to an array of attachmentCount valid ImageView handles
  • If flags does not include FRAMEBUFFER_CREATE_IMAGELESS_BIT, each element of pAttachments that is used as a color attachment or resolve attachment by renderPass must have been created with a usage value including IMAGE_USAGE_COLOR_ATTACHMENT_BIT
  • If flags does not include FRAMEBUFFER_CREATE_IMAGELESS_BIT, each element of pAttachments that is used as a depth/stencil attachment by renderPass must have been created with a usage value including IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT
  • If flags does not include FRAMEBUFFER_CREATE_IMAGELESS_BIT, each element of pAttachments that is used as a depth/stencil resolve attachment by renderPass must have been created with a usage value including IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT
  • If flags does not include FRAMEBUFFER_CREATE_IMAGELESS_BIT, each element of pAttachments that is used as an input attachment by renderPass must have been created with a usage value including IMAGE_USAGE_INPUT_ATTACHMENT_BIT
  • Each element of pAttachments that is used as a fragment density map attachment by renderPass must not have been created with a flags value including IMAGE_CREATE_SUBSAMPLED_BIT_EXT
  • If renderPass has a fragment density map attachment and non-subsample image feature is not enabled, each element of pAttachments must have been created with a flags value including IMAGE_CREATE_SUBSAMPLED_BIT_EXT unless that element is the fragment density map attachment
  • If flags does not include FRAMEBUFFER_CREATE_IMAGELESS_BIT, each element of pAttachments must have been created with a Format value that matches the Format specified by the corresponding AttachmentDescription in renderPass
  • If flags does not include FRAMEBUFFER_CREATE_IMAGELESS_BIT, each element of pAttachments must have been created with a samples value that matches the samples value specified by the corresponding AttachmentDescription in renderPass
  • If flags does not include FRAMEBUFFER_CREATE_IMAGELESS_BIT, each element of pAttachments that is used as an input, color, resolve, or depth/stencil attachment by renderPass must have been created with a VkImageCreateInfo::width greater than or equal to width
  • If flags does not include FRAMEBUFFER_CREATE_IMAGELESS_BIT, each element of pAttachments that is used as an input, color, resolve, or depth/stencil attachment by renderPass must have been created with a VkImageCreateInfo::height greater than or equal to height
  • If flags does not include FRAMEBUFFER_CREATE_IMAGELESS_BIT, each element of pAttachments that is used as an input, color, resolve, or depth/stencil attachment by renderPass must have been created with a VkImageViewCreateInfo::subresourceRange.pname:layerCount greater than or equal to layers
  • If renderPass was specified with non-zero view masks, each element of pAttachments that is used as an input, color, resolve, or depth/stencil attachment by renderPass must have a layerCount greater than the index of the most significant bit set in any of those view masks
  • If renderPass was specified with non-zero view masks, each element of pAttachments that is referenced by fragmentDensityMapAttachment must have a layerCount equal to 1 or greater than the index of the most significant bit set in any of those view masks
  • If renderPass was not specified with non-zero view masks, each element of pAttachments that is referenced by fragmentDensityMapAttachment must have a layerCount equal to 1
  • If flags does not include FRAMEBUFFER_CREATE_IMAGELESS_BIT, an element of pAttachments that is referenced by fragmentDensityMapAttachment must have a width at least as large as \(\left\lceil{\frac{width}{maxFragmentDensityTexelSize_{width}}}\right\rceil\)
  • If flags does not include FRAMEBUFFER_CREATE_IMAGELESS_BIT, an element of pAttachments that is referenced by fragmentDensityMapAttachment must have a height at least as large as \(\left\lceil{\frac{height}{maxFragmentDensityTexelSize_{height}}}\right\rceil\)
  • If flags does not include FRAMEBUFFER_CREATE_IMAGELESS_BIT, and renderPass was specified with non-zero view masks, each element of pAttachments that is used as a fragment shading rate attachment by renderPass must have a layerCount that is either 1, or greater than the index of the most significant bit set in any of those view masks
  • If flags does not include FRAMEBUFFER_CREATE_IMAGELESS_BIT, and renderPass was not specified with non-zero view masks, each element of pAttachments that is used as a fragment shading rate attachment by renderPass must have a layerCount that is either 1, or greater than layers
  • If flags does not include FRAMEBUFFER_CREATE_IMAGELESS_BIT, an element of pAttachments that is used as a fragment shading rate attachment must have a width at least as large as ⌈width \ texelWidth⌉, where texelWidth is the largest value of shadingRateAttachmentTexelSize.width in a FragmentShadingRateAttachmentInfoKHR which references that attachment
  • If flags does not include FRAMEBUFFER_CREATE_IMAGELESS_BIT, an element of pAttachments that is used as a fragment shading rate attachment must have a height at least as large as ⌈height -- texelHeight⌉, where texelHeight is the largest value of

Constructors

FramebufferCreateInfo 

Fields

Instances

Instances details
Extensible FramebufferCreateInfo Source # 
Instance details

Defined in Vulkan.Core10.Pass

Methods

extensibleTypeName :: String Source #

getNext :: forall (es :: [Type]). FramebufferCreateInfo es -> Chain es Source #

setNext :: forall (ds :: [Type]) (es :: [Type]). FramebufferCreateInfo ds -> Chain es -> FramebufferCreateInfo es Source #

extends :: forall e b proxy. Typeable e => proxy e -> (Extends FramebufferCreateInfo e => b) -> Maybe b Source #

Show (Chain es) => Show (FramebufferCreateInfo es) Source # 
Instance details

Defined in Vulkan.Core10.Pass

(Extendss FramebufferCreateInfo es, PeekChain es) => FromCStruct (FramebufferCreateInfo es) Source # 
Instance details

Defined in Vulkan.Core10.Pass

(Extendss FramebufferCreateInfo es, PokeChain es) => ToCStruct (FramebufferCreateInfo es) Source # 
Instance details

Defined in Vulkan.Core10.Pass

es ~ ('[] :: [Type]) => Zero (FramebufferCreateInfo es) Source # 
Instance details

Defined in Vulkan.Core10.Pass

newtype Framebuffer Source #

VkFramebuffer - Opaque handle to a framebuffer object

See Also

CommandBufferInheritanceInfo, RenderPassBeginInfo, createFramebuffer, destroyFramebuffer

Constructors

Framebuffer Word64 

Instances

Instances details
Eq Framebuffer Source # 
Instance details

Defined in Vulkan.Core10.Handles

Ord Framebuffer Source # 
Instance details

Defined in Vulkan.Core10.Handles

Show Framebuffer Source # 
Instance details

Defined in Vulkan.Core10.Handles

Storable Framebuffer Source # 
Instance details

Defined in Vulkan.Core10.Handles

Zero Framebuffer Source # 
Instance details

Defined in Vulkan.Core10.Handles

HasObjectType Framebuffer Source # 
Instance details

Defined in Vulkan.Core10.Handles

IsHandle Framebuffer Source # 
Instance details

Defined in Vulkan.Core10.Handles

newtype RenderPass Source #

Constructors

RenderPass Word64 

Instances

Instances details
Eq RenderPass Source # 
Instance details

Defined in Vulkan.Core10.Handles

Ord RenderPass Source # 
Instance details

Defined in Vulkan.Core10.Handles

Show RenderPass Source # 
Instance details

Defined in Vulkan.Core10.Handles

Storable RenderPass Source # 
Instance details

Defined in Vulkan.Core10.Handles

Zero RenderPass Source # 
Instance details

Defined in Vulkan.Core10.Handles

HasObjectType RenderPass Source # 
Instance details

Defined in Vulkan.Core10.Handles

IsHandle RenderPass Source # 
Instance details

Defined in Vulkan.Core10.Handles

newtype AttachmentLoadOp Source #

VkAttachmentLoadOp - Specify how contents of an attachment are treated at the beginning of a subpass

See Also

AttachmentDescription, AttachmentDescription2

Constructors

AttachmentLoadOp Int32 

Bundled Patterns

pattern ATTACHMENT_LOAD_OP_LOAD :: AttachmentLoadOp

ATTACHMENT_LOAD_OP_LOAD specifies that the previous contents of the image within the render area will be preserved. For attachments with a depth/stencil format, this uses the access type ACCESS_DEPTH_STENCIL_ATTACHMENT_READ_BIT. For attachments with a color format, this uses the access type ACCESS_COLOR_ATTACHMENT_READ_BIT.

pattern ATTACHMENT_LOAD_OP_CLEAR :: AttachmentLoadOp

ATTACHMENT_LOAD_OP_CLEAR specifies that the contents within the render area will be cleared to a uniform value, which is specified when a render pass instance is begun. For attachments with a depth/stencil format, this uses the access type ACCESS_DEPTH_STENCIL_ATTACHMENT_WRITE_BIT. For attachments with a color format, this uses the access type ACCESS_COLOR_ATTACHMENT_WRITE_BIT.

pattern ATTACHMENT_LOAD_OP_DONT_CARE :: AttachmentLoadOp

ATTACHMENT_LOAD_OP_DONT_CARE specifies that the previous contents within the area need not be preserved; the contents of the attachment will be undefined inside the render area. For attachments with a depth/stencil format, this uses the access type ACCESS_DEPTH_STENCIL_ATTACHMENT_WRITE_BIT. For attachments with a color format, this uses the access type ACCESS_COLOR_ATTACHMENT_WRITE_BIT.

Instances

Instances details
Eq AttachmentLoadOp Source # 
Instance details

Defined in Vulkan.Core10.Enums.AttachmentLoadOp

Ord AttachmentLoadOp Source # 
Instance details

Defined in Vulkan.Core10.Enums.AttachmentLoadOp

Read AttachmentLoadOp Source # 
Instance details

Defined in Vulkan.Core10.Enums.AttachmentLoadOp

Show AttachmentLoadOp Source # 
Instance details

Defined in Vulkan.Core10.Enums.AttachmentLoadOp

Storable AttachmentLoadOp Source # 
Instance details

Defined in Vulkan.Core10.Enums.AttachmentLoadOp

Zero AttachmentLoadOp Source # 
Instance details

Defined in Vulkan.Core10.Enums.AttachmentLoadOp

newtype AttachmentStoreOp Source #

VkAttachmentStoreOp - Specify how contents of an attachment are treated at the end of a subpass

Description

Note

ATTACHMENT_STORE_OP_DONT_CARE can cause contents generated during previous render passes to be discarded before reaching memory, even if no write to the attachment occurs during the current render pass.

See Also

AttachmentDescription, AttachmentDescription2

Constructors

AttachmentStoreOp Int32 

Bundled Patterns

pattern ATTACHMENT_STORE_OP_STORE :: AttachmentStoreOp

ATTACHMENT_STORE_OP_STORE specifies the contents generated during the render pass and within the render area are written to memory. For attachments with a depth/stencil format, this uses the access type ACCESS_DEPTH_STENCIL_ATTACHMENT_WRITE_BIT. For attachments with a color format, this uses the access type ACCESS_COLOR_ATTACHMENT_WRITE_BIT.

pattern ATTACHMENT_STORE_OP_DONT_CARE :: AttachmentStoreOp

ATTACHMENT_STORE_OP_DONT_CARE specifies the contents within the render area are not needed after rendering, and may be discarded; the contents of the attachment will be undefined inside the render area. For attachments with a depth/stencil format, this uses the access type ACCESS_DEPTH_STENCIL_ATTACHMENT_WRITE_BIT. For attachments with a color format, this uses the access type ACCESS_COLOR_ATTACHMENT_WRITE_BIT.

pattern ATTACHMENT_STORE_OP_NONE_QCOM :: AttachmentStoreOp

ATTACHMENT_STORE_OP_NONE_QCOM specifies that the contents within the render area were not written during rendering, and may not be written to memory. If the attachment was written to during the renderpass, the contents of the attachment will be undefined inside the render area.

Instances

Instances details
Eq AttachmentStoreOp Source # 
Instance details

Defined in Vulkan.Core10.Enums.AttachmentStoreOp

Ord AttachmentStoreOp Source # 
Instance details

Defined in Vulkan.Core10.Enums.AttachmentStoreOp

Read AttachmentStoreOp Source # 
Instance details

Defined in Vulkan.Core10.Enums.AttachmentStoreOp

Show AttachmentStoreOp Source # 
Instance details

Defined in Vulkan.Core10.Enums.AttachmentStoreOp

Storable AttachmentStoreOp Source # 
Instance details

Defined in Vulkan.Core10.Enums.AttachmentStoreOp

Zero AttachmentStoreOp Source # 
Instance details

Defined in Vulkan.Core10.Enums.AttachmentStoreOp

newtype PipelineBindPoint Source #

Constructors

PipelineBindPoint Int32 

Bundled Patterns

pattern PIPELINE_BIND_POINT_GRAPHICS :: PipelineBindPoint

PIPELINE_BIND_POINT_GRAPHICS specifies binding as a graphics pipeline.

pattern PIPELINE_BIND_POINT_COMPUTE :: PipelineBindPoint

PIPELINE_BIND_POINT_COMPUTE specifies binding as a compute pipeline.

pattern PIPELINE_BIND_POINT_RAY_TRACING_KHR :: PipelineBindPoint

PIPELINE_BIND_POINT_RAY_TRACING_KHR specifies binding as a ray tracing pipeline.

Instances

Instances details
Eq PipelineBindPoint Source # 
Instance details

Defined in Vulkan.Core10.Enums.PipelineBindPoint

Ord PipelineBindPoint Source # 
Instance details

Defined in Vulkan.Core10.Enums.PipelineBindPoint

Read PipelineBindPoint Source # 
Instance details

Defined in Vulkan.Core10.Enums.PipelineBindPoint

Show PipelineBindPoint Source # 
Instance details

Defined in Vulkan.Core10.Enums.PipelineBindPoint

Storable PipelineBindPoint Source # 
Instance details

Defined in Vulkan.Core10.Enums.PipelineBindPoint

Zero PipelineBindPoint Source # 
Instance details

Defined in Vulkan.Core10.Enums.PipelineBindPoint

newtype RenderPassCreateFlagBits Source #

VkRenderPassCreateFlagBits - Bitmask specifying additional properties of a renderpass

See Also

RenderPassCreateFlags

Bundled Patterns

pattern RENDER_PASS_CREATE_TRANSFORM_BIT_QCOM :: RenderPassCreateFlagBits

RENDER_PASS_CREATE_TRANSFORM_BIT_QCOM specifies that the created renderpass is compatible with render pass transform.

Instances

Instances details
Eq RenderPassCreateFlagBits Source # 
Instance details

Defined in Vulkan.Core10.Enums.RenderPassCreateFlagBits

Ord RenderPassCreateFlagBits Source # 
Instance details

Defined in Vulkan.Core10.Enums.RenderPassCreateFlagBits

Read RenderPassCreateFlagBits Source # 
Instance details

Defined in Vulkan.Core10.Enums.RenderPassCreateFlagBits

Show RenderPassCreateFlagBits Source # 
Instance details

Defined in Vulkan.Core10.Enums.RenderPassCreateFlagBits

Storable RenderPassCreateFlagBits Source # 
Instance details

Defined in Vulkan.Core10.Enums.RenderPassCreateFlagBits

Bits RenderPassCreateFlagBits Source # 
Instance details

Defined in Vulkan.Core10.Enums.RenderPassCreateFlagBits

FiniteBits RenderPassCreateFlagBits Source # 
Instance details

Defined in Vulkan.Core10.Enums.RenderPassCreateFlagBits

Zero RenderPassCreateFlagBits Source # 
Instance details

Defined in Vulkan.Core10.Enums.RenderPassCreateFlagBits

newtype AccessFlagBits Source #

VkAccessFlagBits - Bitmask specifying memory access types that will participate in a memory dependency

Description

Certain access types are only performed by a subset of pipeline stages. Any synchronization command that takes both stage masks and access masks uses both to define the access scopes - only the specified access types performed by the specified stages are included in the access scope. An application must not specify an access flag in a synchronization command if it does not include a pipeline stage in the corresponding stage mask that is able to perform accesses of that type. The following table lists, for each access flag, which pipeline stages can perform that type of access.

Access flag Supported pipeline stages
ACCESS_INDIRECT_COMMAND_READ_BIT PIPELINE_STAGE_DRAW_INDIRECT_BIT , PIPELINE_STAGE_ACCELERATION_STRUCTURE_BUILD_BIT_KHR
ACCESS_INDEX_READ_BIT PIPELINE_STAGE_VERTEX_INPUT_BIT
ACCESS_VERTEX_ATTRIBUTE_READ_BIT PIPELINE_STAGE_VERTEX_INPUT_BIT
ACCESS_UNIFORM_READ_BIT PIPELINE_STAGE_TASK_SHADER_BIT_NV, PIPELINE_STAGE_MESH_SHADER_BIT_NV, PIPELINE_STAGE_RAY_TRACING_SHADER_BIT_KHR, PIPELINE_STAGE_VERTEX_SHADER_BIT, PIPELINE_STAGE_TESSELLATION_CONTROL_SHADER_BIT, PIPELINE_STAGE_TESSELLATION_EVALUATION_SHADER_BIT, PIPELINE_STAGE_GEOMETRY_SHADER_BIT, PIPELINE_STAGE_FRAGMENT_SHADER_BIT, or PIPELINE_STAGE_COMPUTE_SHADER_BIT
ACCESS_SHADER_READ_BIT PIPELINE_STAGE_ACCELERATION_STRUCTURE_BUILD_BIT_KHR, PIPELINE_STAGE_TASK_SHADER_BIT_NV, PIPELINE_STAGE_MESH_SHADER_BIT_NV, PIPELINE_STAGE_RAY_TRACING_SHADER_BIT_KHR, PIPELINE_STAGE_VERTEX_SHADER_BIT, PIPELINE_STAGE_TESSELLATION_CONTROL_SHADER_BIT, PIPELINE_STAGE_TESSELLATION_EVALUATION_SHADER_BIT, PIPELINE_STAGE_GEOMETRY_SHADER_BIT, PIPELINE_STAGE_FRAGMENT_SHADER_BIT, or PIPELINE_STAGE_COMPUTE_SHADER_BIT
ACCESS_SHADER_WRITE_BIT PIPELINE_STAGE_TASK_SHADER_BIT_NV, PIPELINE_STAGE_MESH_SHADER_BIT_NV, PIPELINE_STAGE_RAY_TRACING_SHADER_BIT_KHR, PIPELINE_STAGE_VERTEX_SHADER_BIT, PIPELINE_STAGE_TESSELLATION_CONTROL_SHADER_BIT, PIPELINE_STAGE_TESSELLATION_EVALUATION_SHADER_BIT, PIPELINE_STAGE_GEOMETRY_SHADER_BIT, PIPELINE_STAGE_FRAGMENT_SHADER_BIT, or PIPELINE_STAGE_COMPUTE_SHADER_BIT
ACCESS_INPUT_ATTACHMENT_READ_BIT PIPELINE_STAGE_FRAGMENT_SHADER_BIT
ACCESS_COLOR_ATTACHMENT_READ_BIT PIPELINE_STAGE_COLOR_ATTACHMENT_OUTPUT_BIT
ACCESS_COLOR_ATTACHMENT_WRITE_BIT PIPELINE_STAGE_COLOR_ATTACHMENT_OUTPUT_BIT
ACCESS_DEPTH_STENCIL_ATTACHMENT_READ_BIT PIPELINE_STAGE_EARLY_FRAGMENT_TESTS_BIT, or PIPELINE_STAGE_LATE_FRAGMENT_TESTS_BIT
ACCESS_DEPTH_STENCIL_ATTACHMENT_WRITE_BIT PIPELINE_STAGE_EARLY_FRAGMENT_TESTS_BIT, or PIPELINE_STAGE_LATE_FRAGMENT_TESTS_BIT
ACCESS_TRANSFER_READ_BIT PIPELINE_STAGE_TRANSFER_BIT or PIPELINE_STAGE_ACCELERATION_STRUCTURE_BUILD_BIT_KHR
ACCESS_TRANSFER_WRITE_BIT PIPELINE_STAGE_TRANSFER_BIT or PIPELINE_STAGE_ACCELERATION_STRUCTURE_BUILD_BIT_KHR
ACCESS_HOST_READ_BIT PIPELINE_STAGE_HOST_BIT
ACCESS_HOST_WRITE_BIT PIPELINE_STAGE_HOST_BIT
ACCESS_MEMORY_READ_BIT Any
ACCESS_MEMORY_WRITE_BIT Any
ACCESS_COLOR_ATTACHMENT_READ_NONCOHERENT_BIT_EXT PIPELINE_STAGE_COLOR_ATTACHMENT_OUTPUT_BIT
ACCESS_COMMAND_PREPROCESS_READ_BIT_NV PIPELINE_STAGE_COMMAND_PREPROCESS_BIT_NV
ACCESS_COMMAND_PREPROCESS_WRITE_BIT_NV PIPELINE_STAGE_COMMAND_PREPROCESS_BIT_NV
ACCESS_CONDITIONAL_RENDERING_READ_BIT_EXT PIPELINE_STAGE_CONDITIONAL_RENDERING_BIT_EXT
ACCESS_FRAGMENT_SHADING_RATE_ATTACHMENT_READ_BIT_KHR PIPELINE_STAGE_FRAGMENT_SHADING_RATE_ATTACHMENT_BIT_KHR
ACCESS_TRANSFORM_FEEDBACK_WRITE_BIT_EXT PIPELINE_STAGE_TRANSFORM_FEEDBACK_BIT_EXT
ACCESS_TRANSFORM_FEEDBACK_COUNTER_WRITE_BIT_EXT PIPELINE_STAGE_TRANSFORM_FEEDBACK_BIT_EXT
ACCESS_TRANSFORM_FEEDBACK_COUNTER_READ_BIT_EXT PIPELINE_STAGE_DRAW_INDIRECT_BIT
ACCESS_ACCELERATION_STRUCTURE_READ_BIT_KHR PIPELINE_STAGE_TASK_SHADER_BIT_NV, PIPELINE_STAGE_MESH_SHADER_BIT_NV, PIPELINE_STAGE_VERTEX_SHADER_BIT, PIPELINE_STAGE_TESSELLATION_CONTROL_SHADER_BIT, PIPELINE_STAGE_TESSELLATION_EVALUATION_SHADER_BIT, PIPELINE_STAGE_GEOMETRY_SHADER_BIT, PIPELINE_STAGE_FRAGMENT_SHADER_BIT, PIPELINE_STAGE_COMPUTE_SHADER_BIT, PIPELINE_STAGE_RAY_TRACING_SHADER_BIT_KHR, or PIPELINE_STAGE_ACCELERATION_STRUCTURE_BUILD_BIT_KHR
ACCESS_ACCELERATION_STRUCTURE_WRITE_BIT_KHR PIPELINE_STAGE_ACCELERATION_STRUCTURE_BUILD_BIT_KHR
ACCESS_FRAGMENT_DENSITY_MAP_READ_BIT_EXT PIPELINE_STAGE_FRAGMENT_DENSITY_PROCESS_BIT_EXT

Supported access types

See Also

AccessFlags

Constructors

AccessFlagBits Flags 

Bundled Patterns

pattern ACCESS_INDIRECT_COMMAND_READ_BIT :: AccessFlagBits

ACCESS_INDIRECT_COMMAND_READ_BIT specifies read access to indirect command data read as part of an indirect build, trace, drawing or dispatch command.

pattern ACCESS_INDEX_READ_BIT :: AccessFlagBits

ACCESS_INDEX_READ_BIT specifies read access to an index buffer as part of an indexed drawing command, bound by cmdBindIndexBuffer.

pattern ACCESS_VERTEX_ATTRIBUTE_READ_BIT :: AccessFlagBits

ACCESS_VERTEX_ATTRIBUTE_READ_BIT specifies read access to a vertex buffer as part of a drawing command, bound by cmdBindVertexBuffers.

pattern ACCESS_UNIFORM_READ_BIT :: AccessFlagBits

ACCESS_UNIFORM_READ_BIT specifies read access to a uniform buffer.

pattern ACCESS_INPUT_ATTACHMENT_READ_BIT :: AccessFlagBits

ACCESS_INPUT_ATTACHMENT_READ_BIT specifies read access to an input attachment within a render pass during fragment shading.

pattern ACCESS_SHADER_READ_BIT :: AccessFlagBits

ACCESS_SHADER_READ_BIT specifies read access to a storage buffer, physical storage buffer, shader binding table, uniform texel buffer, storage texel buffer, sampled image, or storage image.

pattern ACCESS_SHADER_WRITE_BIT :: AccessFlagBits

ACCESS_SHADER_WRITE_BIT specifies write access to a storage buffer, physical storage buffer, storage texel buffer, or storage image.

pattern ACCESS_COLOR_ATTACHMENT_READ_BIT :: AccessFlagBits

ACCESS_COLOR_ATTACHMENT_READ_BIT specifies read access to a color attachment, such as via blending, logic operations, or via certain subpass load operations. It does not include advanced blend operations.

pattern ACCESS_COLOR_ATTACHMENT_WRITE_BIT :: AccessFlagBits

ACCESS_COLOR_ATTACHMENT_WRITE_BIT specifies write access to a color, resolve, or depth/stencil resolve attachment during a render pass or via certain subpass load and store operations.

pattern ACCESS_DEPTH_STENCIL_ATTACHMENT_READ_BIT :: AccessFlagBits

ACCESS_DEPTH_STENCIL_ATTACHMENT_READ_BIT specifies read access to a depth/stencil attachment, via depth or stencil operations or via certain subpass load operations.

pattern ACCESS_DEPTH_STENCIL_ATTACHMENT_WRITE_BIT :: AccessFlagBits

ACCESS_DEPTH_STENCIL_ATTACHMENT_WRITE_BIT specifies write access to a depth/stencil attachment, via depth or stencil operations or via certain subpass load and store operations.

pattern ACCESS_TRANSFER_READ_BIT :: AccessFlagBits

ACCESS_TRANSFER_READ_BIT specifies read access to an image or buffer in a copy operation.

pattern ACCESS_TRANSFER_WRITE_BIT :: AccessFlagBits

ACCESS_TRANSFER_WRITE_BIT specifies write access to an image or buffer in a clear or copy operation.

pattern ACCESS_HOST_READ_BIT :: AccessFlagBits

ACCESS_HOST_READ_BIT specifies read access by a host operation. Accesses of this type are not performed through a resource, but directly on memory.

pattern ACCESS_HOST_WRITE_BIT :: AccessFlagBits

ACCESS_HOST_WRITE_BIT specifies write access by a host operation. Accesses of this type are not performed through a resource, but directly on memory.

pattern ACCESS_MEMORY_READ_BIT :: AccessFlagBits

ACCESS_MEMORY_READ_BIT specifies all read accesses. It is always valid in any access mask, and is treated as equivalent to setting all READ access flags that are valid where it is used.

pattern ACCESS_MEMORY_WRITE_BIT :: AccessFlagBits

ACCESS_MEMORY_WRITE_BIT specifies all write accesses. It is always valid in any access mask, and is treated as equivalent to setting all WRITE access flags that are valid where it is used.

pattern ACCESS_COMMAND_PREPROCESS_WRITE_BIT_NV :: AccessFlagBits

ACCESS_COMMAND_PREPROCESS_WRITE_BIT_NV specifies writes to the Buffer preprocess outputs in cmdPreprocessGeneratedCommandsNV.

pattern ACCESS_COMMAND_PREPROCESS_READ_BIT_NV :: AccessFlagBits

ACCESS_COMMAND_PREPROCESS_READ_BIT_NV specifies reads from Buffer inputs to cmdPreprocessGeneratedCommandsNV.

pattern ACCESS_FRAGMENT_DENSITY_MAP_READ_BIT_EXT :: AccessFlagBits

ACCESS_FRAGMENT_DENSITY_MAP_READ_BIT_EXT specifies read access to a fragment density map attachment during dynamic fragment density map operations

pattern ACCESS_SHADING_RATE_IMAGE_READ_BIT_NV :: AccessFlagBits 
pattern ACCESS_ACCELERATION_STRUCTURE_WRITE_BIT_KHR :: AccessFlagBits

ACCESS_ACCELERATION_STRUCTURE_WRITE_BIT_KHR specifies write access to an acceleration structure or acceleration structure scratch buffer as part of a build or copy command.

pattern ACCESS_ACCELERATION_STRUCTURE_READ_BIT_KHR :: AccessFlagBits

ACCESS_ACCELERATION_STRUCTURE_READ_BIT_KHR specifies read access to an acceleration structure as part of a trace, build, or copy command, or to an acceleration structure scratch buffer as part of a build command.

pattern ACCESS_COLOR_ATTACHMENT_READ_NONCOHERENT_BIT_EXT :: AccessFlagBits

ACCESS_COLOR_ATTACHMENT_READ_NONCOHERENT_BIT_EXT is similar to ACCESS_COLOR_ATTACHMENT_READ_BIT, but also includes advanced blend operations.

pattern ACCESS_CONDITIONAL_RENDERING_READ_BIT_EXT :: AccessFlagBits

ACCESS_CONDITIONAL_RENDERING_READ_BIT_EXT specifies read access to a predicate as part of conditional rendering.

pattern ACCESS_TRANSFORM_FEEDBACK_COUNTER_WRITE_BIT_EXT :: AccessFlagBits

ACCESS_TRANSFORM_FEEDBACK_COUNTER_WRITE_BIT_EXT specifies write access to a transform feedback counter buffer which is written when cmdEndTransformFeedbackEXT executes.

pattern ACCESS_TRANSFORM_FEEDBACK_COUNTER_READ_BIT_EXT :: AccessFlagBits

ACCESS_TRANSFORM_FEEDBACK_COUNTER_READ_BIT_EXT specifies read access to a transform feedback counter buffer which is read when cmdBeginTransformFeedbackEXT executes.

pattern ACCESS_TRANSFORM_FEEDBACK_WRITE_BIT_EXT :: AccessFlagBits

ACCESS_TRANSFORM_FEEDBACK_WRITE_BIT_EXT specifies write access to a transform feedback buffer made when transform feedback is active.

Instances

Instances details
Eq AccessFlagBits Source # 
Instance details

Defined in Vulkan.Core10.Enums.AccessFlagBits

Ord AccessFlagBits Source # 
Instance details

Defined in Vulkan.Core10.Enums.AccessFlagBits

Read AccessFlagBits Source # 
Instance details

Defined in Vulkan.Core10.Enums.AccessFlagBits

Show AccessFlagBits Source # 
Instance details

Defined in Vulkan.Core10.Enums.AccessFlagBits

Storable AccessFlagBits Source # 
Instance details

Defined in Vulkan.Core10.Enums.AccessFlagBits

Bits AccessFlagBits Source # 
Instance details

Defined in Vulkan.Core10.Enums.AccessFlagBits

FiniteBits AccessFlagBits Source # 
Instance details

Defined in Vulkan.Core10.Enums.AccessFlagBits

Zero AccessFlagBits Source # 
Instance details

Defined in Vulkan.Core10.Enums.AccessFlagBits

newtype AttachmentDescriptionFlagBits Source #

VkAttachmentDescriptionFlagBits - Bitmask specifying additional properties of an attachment

See Also

AttachmentDescriptionFlags

Bundled Patterns

pattern ATTACHMENT_DESCRIPTION_MAY_ALIAS_BIT :: AttachmentDescriptionFlagBits

ATTACHMENT_DESCRIPTION_MAY_ALIAS_BIT specifies that the attachment aliases the same device memory as other attachments.

Instances

Instances details
Eq AttachmentDescriptionFlagBits Source # 
Instance details

Defined in Vulkan.Core10.Enums.AttachmentDescriptionFlagBits

Ord AttachmentDescriptionFlagBits Source # 
Instance details

Defined in Vulkan.Core10.Enums.AttachmentDescriptionFlagBits

Read AttachmentDescriptionFlagBits Source # 
Instance details

Defined in Vulkan.Core10.Enums.AttachmentDescriptionFlagBits

Show AttachmentDescriptionFlagBits Source # 
Instance details

Defined in Vulkan.Core10.Enums.AttachmentDescriptionFlagBits

Storable AttachmentDescriptionFlagBits Source # 
Instance details

Defined in Vulkan.Core10.Enums.AttachmentDescriptionFlagBits

Bits AttachmentDescriptionFlagBits Source # 
Instance details

Defined in Vulkan.Core10.Enums.AttachmentDescriptionFlagBits

Methods

(.&.) :: AttachmentDescriptionFlagBits -> AttachmentDescriptionFlagBits -> AttachmentDescriptionFlagBits #

(.|.) :: AttachmentDescriptionFlagBits -> AttachmentDescriptionFlagBits -> AttachmentDescriptionFlagBits #

xor :: AttachmentDescriptionFlagBits -> AttachmentDescriptionFlagBits -> AttachmentDescriptionFlagBits #

complement :: AttachmentDescriptionFlagBits -> AttachmentDescriptionFlagBits #

shift :: AttachmentDescriptionFlagBits -> Int -> AttachmentDescriptionFlagBits #

rotate :: AttachmentDescriptionFlagBits -> Int -> AttachmentDescriptionFlagBits #

zeroBits :: AttachmentDescriptionFlagBits #

bit :: Int -> AttachmentDescriptionFlagBits #

setBit :: AttachmentDescriptionFlagBits -> Int -> AttachmentDescriptionFlagBits #

clearBit :: AttachmentDescriptionFlagBits -> Int -> AttachmentDescriptionFlagBits #

complementBit :: AttachmentDescriptionFlagBits -> Int -> AttachmentDescriptionFlagBits #

testBit :: AttachmentDescriptionFlagBits -> Int -> Bool #

bitSizeMaybe :: AttachmentDescriptionFlagBits -> Maybe Int #

bitSize :: AttachmentDescriptionFlagBits -> Int #

isSigned :: AttachmentDescriptionFlagBits -> Bool #

shiftL :: AttachmentDescriptionFlagBits -> Int -> AttachmentDescriptionFlagBits #

unsafeShiftL :: AttachmentDescriptionFlagBits -> Int -> AttachmentDescriptionFlagBits #

shiftR :: AttachmentDescriptionFlagBits -> Int -> AttachmentDescriptionFlagBits #

unsafeShiftR :: AttachmentDescriptionFlagBits -> Int -> AttachmentDescriptionFlagBits #

rotateL :: AttachmentDescriptionFlagBits -> Int -> AttachmentDescriptionFlagBits #

rotateR :: AttachmentDescriptionFlagBits -> Int -> AttachmentDescriptionFlagBits #

popCount :: AttachmentDescriptionFlagBits -> Int #

FiniteBits AttachmentDescriptionFlagBits Source # 
Instance details

Defined in Vulkan.Core10.Enums.AttachmentDescriptionFlagBits

Zero AttachmentDescriptionFlagBits Source # 
Instance details

Defined in Vulkan.Core10.Enums.AttachmentDescriptionFlagBits

newtype DependencyFlagBits Source #

VkDependencyFlagBits - Bitmask specifying how execution and memory dependencies are formed

See Also

DependencyFlags

Instances

Instances details
Eq DependencyFlagBits Source # 
Instance details

Defined in Vulkan.Core10.Enums.DependencyFlagBits

Ord DependencyFlagBits Source # 
Instance details

Defined in Vulkan.Core10.Enums.DependencyFlagBits

Read DependencyFlagBits Source # 
Instance details

Defined in Vulkan.Core10.Enums.DependencyFlagBits

Show DependencyFlagBits Source # 
Instance details

Defined in Vulkan.Core10.Enums.DependencyFlagBits

Storable DependencyFlagBits Source # 
Instance details

Defined in Vulkan.Core10.Enums.DependencyFlagBits

Bits DependencyFlagBits Source # 
Instance details

Defined in Vulkan.Core10.Enums.DependencyFlagBits

FiniteBits DependencyFlagBits Source # 
Instance details

Defined in Vulkan.Core10.Enums.DependencyFlagBits

Zero DependencyFlagBits Source # 
Instance details

Defined in Vulkan.Core10.Enums.DependencyFlagBits

newtype SubpassDescriptionFlagBits Source #

VkSubpassDescriptionFlagBits - Bitmask specifying usage of a subpass

Description

Note

Shader resolve operations allow for custom resolve operations, but overdrawing pixels may have a performance and/or power cost. Furthermore, since the content of any depth stencil attachment or color attachment is undefined at the begining of a shader resolve subpass, any depth testing, stencil testing, or blending operation which sources these undefined values also has undefined result value.

See Also

SubpassDescriptionFlags

Bundled Patterns

pattern SUBPASS_DESCRIPTION_SHADER_RESOLVE_BIT_QCOM :: SubpassDescriptionFlagBits

SUBPASS_DESCRIPTION_SHADER_RESOLVE_BIT_QCOM specifies that the subpass performs shader resolve operations.

pattern SUBPASS_DESCRIPTION_FRAGMENT_REGION_BIT_QCOM :: SubpassDescriptionFlagBits

SUBPASS_DESCRIPTION_FRAGMENT_REGION_BIT_QCOM specifies that the framebuffer region is the fragment region, that is, the minimum region dependencies are by pixel rather than by sample, such that any fragment shader invocation can access any sample associated with that fragment shader invocation.

pattern SUBPASS_DESCRIPTION_PER_VIEW_POSITION_X_ONLY_BIT_NVX :: SubpassDescriptionFlagBits

SUBPASS_DESCRIPTION_PER_VIEW_POSITION_X_ONLY_BIT_NVX specifies that shaders compiled for this subpass use per-view positions which only differ in value in the x component. Per-view viewport mask can also be used.

pattern SUBPASS_DESCRIPTION_PER_VIEW_ATTRIBUTES_BIT_NVX :: SubpassDescriptionFlagBits

SUBPASS_DESCRIPTION_PER_VIEW_ATTRIBUTES_BIT_NVX specifies that shaders compiled for this subpass write the attributes for all views in a single invocation of each vertex processing stage. All pipelines compiled against a subpass that includes this bit must write per-view attributes to the *PerViewNV[] shader outputs, in addition to the non-per-view (e.g. Position) outputs.

Instances

Instances details
Eq SubpassDescriptionFlagBits Source # 
Instance details

Defined in Vulkan.Core10.Enums.SubpassDescriptionFlagBits

Ord SubpassDescriptionFlagBits Source # 
Instance details

Defined in Vulkan.Core10.Enums.SubpassDescriptionFlagBits

Read SubpassDescriptionFlagBits Source # 
Instance details

Defined in Vulkan.Core10.Enums.SubpassDescriptionFlagBits

Show SubpassDescriptionFlagBits Source # 
Instance details

Defined in Vulkan.Core10.Enums.SubpassDescriptionFlagBits

Storable SubpassDescriptionFlagBits Source # 
Instance details

Defined in Vulkan.Core10.Enums.SubpassDescriptionFlagBits

Bits SubpassDescriptionFlagBits Source # 
Instance details

Defined in Vulkan.Core10.Enums.SubpassDescriptionFlagBits

Methods

(.&.) :: SubpassDescriptionFlagBits -> SubpassDescriptionFlagBits -> SubpassDescriptionFlagBits #

(.|.) :: SubpassDescriptionFlagBits -> SubpassDescriptionFlagBits -> SubpassDescriptionFlagBits #

xor :: SubpassDescriptionFlagBits -> SubpassDescriptionFlagBits -> SubpassDescriptionFlagBits #

complement :: SubpassDescriptionFlagBits -> SubpassDescriptionFlagBits #

shift :: SubpassDescriptionFlagBits -> Int -> SubpassDescriptionFlagBits #

rotate :: SubpassDescriptionFlagBits -> Int -> SubpassDescriptionFlagBits #

zeroBits :: SubpassDescriptionFlagBits #

bit :: Int -> SubpassDescriptionFlagBits #

setBit :: SubpassDescriptionFlagBits -> Int -> SubpassDescriptionFlagBits #

clearBit :: SubpassDescriptionFlagBits -> Int -> SubpassDescriptionFlagBits #

complementBit :: SubpassDescriptionFlagBits -> Int -> SubpassDescriptionFlagBits #

testBit :: SubpassDescriptionFlagBits -> Int -> Bool #

bitSizeMaybe :: SubpassDescriptionFlagBits -> Maybe Int #

bitSize :: SubpassDescriptionFlagBits -> Int #

isSigned :: SubpassDescriptionFlagBits -> Bool #

shiftL :: SubpassDescriptionFlagBits -> Int -> SubpassDescriptionFlagBits #

unsafeShiftL :: SubpassDescriptionFlagBits -> Int -> SubpassDescriptionFlagBits #

shiftR :: SubpassDescriptionFlagBits -> Int -> SubpassDescriptionFlagBits #

unsafeShiftR :: SubpassDescriptionFlagBits -> Int -> SubpassDescriptionFlagBits #

rotateL :: SubpassDescriptionFlagBits -> Int -> SubpassDescriptionFlagBits #

rotateR :: SubpassDescriptionFlagBits -> Int -> SubpassDescriptionFlagBits #

popCount :: SubpassDescriptionFlagBits -> Int #

FiniteBits SubpassDescriptionFlagBits Source # 
Instance details

Defined in Vulkan.Core10.Enums.SubpassDescriptionFlagBits

Zero SubpassDescriptionFlagBits Source # 
Instance details

Defined in Vulkan.Core10.Enums.SubpassDescriptionFlagBits

newtype FramebufferCreateFlagBits Source #

VkFramebufferCreateFlagBits - Bitmask specifying framebuffer properties

See Also

FramebufferCreateFlags

Bundled Patterns

pattern FRAMEBUFFER_CREATE_IMAGELESS_BIT :: FramebufferCreateFlagBits

FRAMEBUFFER_CREATE_IMAGELESS_BIT specifies that image views are not specified, and only attachment compatibility information will be provided via a FramebufferAttachmentImageInfo structure.

Instances

Instances details
Eq FramebufferCreateFlagBits Source # 
Instance details

Defined in Vulkan.Core10.Enums.FramebufferCreateFlagBits

Ord FramebufferCreateFlagBits Source # 
Instance details

Defined in Vulkan.Core10.Enums.FramebufferCreateFlagBits

Read FramebufferCreateFlagBits Source # 
Instance details

Defined in Vulkan.Core10.Enums.FramebufferCreateFlagBits

Show FramebufferCreateFlagBits Source # 
Instance details

Defined in Vulkan.Core10.Enums.FramebufferCreateFlagBits

Storable FramebufferCreateFlagBits Source # 
Instance details

Defined in Vulkan.Core10.Enums.FramebufferCreateFlagBits

Bits FramebufferCreateFlagBits Source # 
Instance details

Defined in Vulkan.Core10.Enums.FramebufferCreateFlagBits

Methods

(.&.) :: FramebufferCreateFlagBits -> FramebufferCreateFlagBits -> FramebufferCreateFlagBits #

(.|.) :: FramebufferCreateFlagBits -> FramebufferCreateFlagBits -> FramebufferCreateFlagBits #

xor :: FramebufferCreateFlagBits -> FramebufferCreateFlagBits -> FramebufferCreateFlagBits #

complement :: FramebufferCreateFlagBits -> FramebufferCreateFlagBits #

shift :: FramebufferCreateFlagBits -> Int -> FramebufferCreateFlagBits #

rotate :: FramebufferCreateFlagBits -> Int -> FramebufferCreateFlagBits #

zeroBits :: FramebufferCreateFlagBits #

bit :: Int -> FramebufferCreateFlagBits #

setBit :: FramebufferCreateFlagBits -> Int -> FramebufferCreateFlagBits #

clearBit :: FramebufferCreateFlagBits -> Int -> FramebufferCreateFlagBits #

complementBit :: FramebufferCreateFlagBits -> Int -> FramebufferCreateFlagBits #

testBit :: FramebufferCreateFlagBits -> Int -> Bool #

bitSizeMaybe :: FramebufferCreateFlagBits -> Maybe Int #

bitSize :: FramebufferCreateFlagBits -> Int #

isSigned :: FramebufferCreateFlagBits -> Bool #

shiftL :: FramebufferCreateFlagBits -> Int -> FramebufferCreateFlagBits #

unsafeShiftL :: FramebufferCreateFlagBits -> Int -> FramebufferCreateFlagBits #

shiftR :: FramebufferCreateFlagBits -> Int -> FramebufferCreateFlagBits #

unsafeShiftR :: FramebufferCreateFlagBits -> Int -> FramebufferCreateFlagBits #

rotateL :: FramebufferCreateFlagBits -> Int -> FramebufferCreateFlagBits #

rotateR :: FramebufferCreateFlagBits -> Int -> FramebufferCreateFlagBits #

popCount :: FramebufferCreateFlagBits -> Int #

FiniteBits FramebufferCreateFlagBits Source # 
Instance details

Defined in Vulkan.Core10.Enums.FramebufferCreateFlagBits

Zero FramebufferCreateFlagBits Source # 
Instance details

Defined in Vulkan.Core10.Enums.FramebufferCreateFlagBits