Vulkan.Core10.Pass

Documentation

createFramebuffer

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

• pCreateInfo must be a valid pointer to a valid FramebufferCreateInfo structure
• If pAllocator is not NULL, pAllocator must be a valid pointer to a valid AllocationCallbacks structure
• pFramebuffer must be a valid pointer to a Framebuffer handle

Return Codes

Success

• SUCCESS

Failure

• ERROR_OUT_OF_HOST_MEMORY
• ERROR_OUT_OF_DEVICE_MEMORY

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

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 first argument. To just extract the pair pass (,) as the first argument.

destroyFramebuffer

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

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

• pCreateInfo must be a valid pointer to a valid RenderPassCreateInfo structure
• If pAllocator is not NULL, pAllocator must be a valid pointer to a valid AllocationCallbacks structure
• pRenderPass must be a valid pointer to a RenderPass handle

Return Codes

Success

• SUCCESS

Failure

• ERROR_OUT_OF_HOST_MEMORY
• ERROR_OUT_OF_DEVICE_MEMORY

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

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 first argument. To just extract the pair pass (,) as the first argument.

destroyRenderPass

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

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

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

• finalLayout must not be IMAGE_LAYOUT_UNDEFINED or IMAGE_LAYOUT_PREINITIALIZED

• If format is a color format, initialLayout must not be IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL, IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL, IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL, or IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL
• If format is a depth/stencil format, initialLayout must not be IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL
• If format is a color format, finalLayout must not be IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL, IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL, IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL, or IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL
• If format is a depth/stencil format, finalLayout must not be IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL
• If the separateDepthStencilLayouts feature is not enabled, initialLayout must not be IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL, IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL, IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL, or IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL
• If the separateDepthStencilLayouts feature is not enabled, finalLayout must not be IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL, IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL, IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL, or IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL
• If format is a color format, initialLayout must not be IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL, IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL, IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL, or IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL
• If format is a color format, finalLayout must not be IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL, IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL, IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL, or IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL
• If format is a depth/stencil format which includes both depth and stencil aspects, initialLayout must not be IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL, IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL, IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL, or IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL
• If format is a depth/stencil format which includes both depth and stencil aspects, finalLayout must not be IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL, IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL, IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL, or IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL
• If format is a depth/stencil format which includes only the depth aspect, initialLayout must not be IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL or IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL
• If format is a depth/stencil format which includes only the depth aspect, finalLayout must not be IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL or IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL
• If format is a depth/stencil format which includes only the stencil aspect, initialLayout must not be IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL or IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL
• If format is a depth/stencil format which includes only the stencil aspect, finalLayout must not be IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL or IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL

Valid Usage (Implicit)

• flags must be a valid combination of AttachmentDescriptionFlagBits values

• format must be a valid Format value
• samples must be a valid SampleCountFlagBits value
• loadOp must be a valid AttachmentLoadOp value
• storeOp must be a valid AttachmentStoreOp value
• stencilLoadOp must be a valid AttachmentLoadOp value
• stencilStoreOp must be a valid AttachmentStoreOp value
• initialLayout must be a valid ImageLayout value
• finalLayout must be a valid ImageLayout value

See Also

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

Constructors

AttachmentDescription

Fields

• flags :: AttachmentDescriptionFlags

  flags is a bitmask of AttachmentDescriptionFlagBits specifying additional properties of the attachment.

• format :: Format

  format is a Format value specifying the format of the image view that will be used for the attachment.

• samples :: SampleCountFlagBits

  samples is the number of samples of the image as defined in SampleCountFlagBits.

• loadOp :: AttachmentLoadOp

  loadOp is a AttachmentLoadOp value specifying how the contents of color and depth components of the attachment are treated at the beginning of the subpass where it is first used.

• storeOp :: AttachmentStoreOp

  storeOp is a AttachmentStoreOp value specifying how the contents of color and depth components of the attachment are treated at the end of the subpass where it is last used.

• stencilLoadOp :: AttachmentLoadOp

  stencilLoadOp is a AttachmentLoadOp value specifying how the contents of stencil components of the attachment are treated at the beginning of the subpass where it is first used.

• stencilStoreOp :: AttachmentStoreOp

  stencilStoreOp is a AttachmentStoreOp value specifying how the contents of stencil components of the attachment are treated at the end of the last subpass where it is used.

• initialLayout :: ImageLayout

  initialLayout is the layout the attachment image subresource will be in when a render pass instance begins.

• finalLayout :: ImageLayout

  finalLayout is the layout the attachment image subresource will be transitioned to when a render pass instance ends.

Instances

Eq AttachmentDescription

Defined in Vulkan.Core10.Pass

Methods

(==) :: AttachmentDescription -> AttachmentDescription -> Bool

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

Show AttachmentDescription

Defined in Vulkan.Core10.Pass

Methods

showsPrec :: Int -> AttachmentDescription -> ShowS

show :: AttachmentDescription -> String

showList :: [AttachmentDescription] -> ShowS

Generic AttachmentDescription

Defined in Vulkan.Core10.Pass

Associated Types

type Rep AttachmentDescription :: Type -> Type

Methods

from :: AttachmentDescription -> Rep AttachmentDescription x

to :: Rep AttachmentDescription x -> AttachmentDescription

Storable AttachmentDescription

Defined in Vulkan.Core10.Pass

Methods

sizeOf :: AttachmentDescription -> Int

alignment :: AttachmentDescription -> Int

peekElemOff :: Ptr AttachmentDescription -> Int -> IO AttachmentDescription

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

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

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

peek :: Ptr AttachmentDescription -> IO AttachmentDescription

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

FromCStruct AttachmentDescription

Defined in Vulkan.Core10.Pass

Methods

peekCStruct :: Ptr AttachmentDescription -> IO AttachmentDescription

ToCStruct AttachmentDescription

Defined in Vulkan.Core10.Pass

Methods

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

pokeCStruct :: Ptr AttachmentDescription -> AttachmentDescription -> IO b -> IO b

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

pokeZeroCStruct :: Ptr AttachmentDescription -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

Zero AttachmentDescription

Defined in Vulkan.Core10.Pass

Methods

zero :: AttachmentDescription

type Rep AttachmentDescription

Defined in Vulkan.Core10.Pass

type Rep AttachmentDescription = D1 ('MetaData "AttachmentDescription" "Vulkan.Core10.Pass" "vulkan-3.6.1-inplace" 'False) (C1 ('MetaCons "AttachmentDescription" 'PrefixI 'True) (((S1 ('MetaSel ('Just "flags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 AttachmentDescriptionFlags) :*: S1 ('MetaSel ('Just "format") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Format)) :*: (S1 ('MetaSel ('Just "samples") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 SampleCountFlagBits) :*: S1 ('MetaSel ('Just "loadOp") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 AttachmentLoadOp))) :*: ((S1 ('MetaSel ('Just "storeOp") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 AttachmentStoreOp) :*: S1 ('MetaSel ('Just "stencilLoadOp") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 AttachmentLoadOp)) :*: (S1 ('MetaSel ('Just "stencilStoreOp") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 AttachmentStoreOp) :*: (S1 ('MetaSel ('Just "initialLayout") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ImageLayout) :*: S1 ('MetaSel ('Just "finalLayout") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ImageLayout))))))

data AttachmentReference

VkAttachmentReference - Structure specifying an attachment reference

Valid Usage

• If attachment is not ATTACHMENT_UNUSED, layout must not be IMAGE_LAYOUT_UNDEFINED, IMAGE_LAYOUT_PREINITIALIZED, IMAGE_LAYOUT_PRESENT_SRC_KHR, IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL_KHR, IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL_KHR, IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL_KHR, or IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL_KHR

Valid Usage (Implicit)

• layout must be a valid ImageLayout value

See Also

ImageLayout, RenderPassFragmentDensityMapCreateInfoEXT, SubpassDescription

Constructors

AttachmentReference

Fields

• attachment :: Word32

  attachment is either an integer value identifying an attachment at the corresponding index in RenderPassCreateInfo::pAttachments, or ATTACHMENT_UNUSED to signify that this attachment is not used.

• layout :: ImageLayout

  layout is a ImageLayout value specifying the layout the attachment uses during the subpass.

Instances

Eq AttachmentReference

Defined in Vulkan.Core10.Pass

Methods

(==) :: AttachmentReference -> AttachmentReference -> Bool

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

Show AttachmentReference

Defined in Vulkan.Core10.Pass

Methods

showsPrec :: Int -> AttachmentReference -> ShowS

show :: AttachmentReference -> String

showList :: [AttachmentReference] -> ShowS

Generic AttachmentReference

Defined in Vulkan.Core10.Pass

Associated Types

type Rep AttachmentReference :: Type -> Type

Methods

from :: AttachmentReference -> Rep AttachmentReference x

to :: Rep AttachmentReference x -> AttachmentReference

Storable AttachmentReference

Defined in Vulkan.Core10.Pass

Methods

sizeOf :: AttachmentReference -> Int

alignment :: AttachmentReference -> Int

peekElemOff :: Ptr AttachmentReference -> Int -> IO AttachmentReference

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

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

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

peek :: Ptr AttachmentReference -> IO AttachmentReference

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

FromCStruct AttachmentReference

Defined in Vulkan.Core10.Pass

Methods

peekCStruct :: Ptr AttachmentReference -> IO AttachmentReference

ToCStruct AttachmentReference

Defined in Vulkan.Core10.Pass

Methods

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

pokeCStruct :: Ptr AttachmentReference -> AttachmentReference -> IO b -> IO b

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

pokeZeroCStruct :: Ptr AttachmentReference -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

Zero AttachmentReference

Defined in Vulkan.Core10.Pass

Methods

zero :: AttachmentReference

type Rep AttachmentReference

Defined in Vulkan.Core10.Pass

type Rep AttachmentReference = D1 ('MetaData "AttachmentReference" "Vulkan.Core10.Pass" "vulkan-3.6.1-inplace" 'False) (C1 ('MetaCons "AttachmentReference" 'PrefixI 'True) (S1 ('MetaSel ('Just "attachment") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Word32) :*: S1 ('MetaSel ('Just "layout") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ImageLayout)))

data SubpassDescription

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:

• SUBPASS_DESCRIPTION_SHADER_RESOLVE_BIT_QCOM is set.
• The attachment is used as a color or depth/stencil in the subpass.

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

• pipelineBindPoint must be PIPELINE_BIND_POINT_GRAPHICS

• colorAttachmentCount must be less than or equal to PhysicalDeviceLimits::maxColorAttachments
• If the first use of an attachment in this render pass is as an input attachment, and the attachment is not also used as a color or depth/stencil attachment in the same subpass, then loadOp must not be ATTACHMENT_LOAD_OP_CLEAR
• If pResolveAttachments is not NULL, for each resolve attachment that is not ATTACHMENT_UNUSED, the corresponding color attachment must not be ATTACHMENT_UNUSED
• If pResolveAttachments is not NULL, for each resolve attachment that is not ATTACHMENT_UNUSED, the corresponding color attachment must not have a sample count of SAMPLE_COUNT_1_BIT
• If pResolveAttachments is not NULL, each resolve attachment that is not ATTACHMENT_UNUSED must have a sample count of SAMPLE_COUNT_1_BIT
• If pResolveAttachments is not NULL, each resolve attachment that is not ATTACHMENT_UNUSED must have the same Format as its corresponding color attachment
• All attachments in pColorAttachments that are not ATTACHMENT_UNUSED must have the same sample count
• All attachments in pInputAttachments that are not ATTACHMENT_UNUSED must have image formats whose potential format features contain at least FORMAT_FEATURE_COLOR_ATTACHMENT_BIT or FORMAT_FEATURE_DEPTH_STENCIL_ATTACHMENT_BIT
• All attachments in pColorAttachments that are not ATTACHMENT_UNUSED must have image formats whose potential format features contain FORMAT_FEATURE_COLOR_ATTACHMENT_BIT
• All attachments in pResolveAttachments that are not ATTACHMENT_UNUSED must have image formats whose potential format features contain FORMAT_FEATURE_COLOR_ATTACHMENT_BIT
• If pDepthStencilAttachment is not NULL and the attachment is not ATTACHMENT_UNUSED then it must have a image format whose potential format features contain FORMAT_FEATURE_DEPTH_STENCIL_ATTACHMENT_BIT
• If the VK_AMD_mixed_attachment_samples extension is enabled, and all attachments in pColorAttachments that are not ATTACHMENT_UNUSED must have a sample count that is smaller than or equal to the sample count of pDepthStencilAttachment if it is not ATTACHMENT_UNUSED
• If neither the VK_AMD_mixed_attachment_samples nor the VK_NV_framebuffer_mixed_samples extensions are enabled, and if pDepthStencilAttachment is not ATTACHMENT_UNUSED and any attachments in pColorAttachments are not ATTACHMENT_UNUSED, they must have the same sample count
• The attachment member of each element of pPreserveAttachments must not be ATTACHMENT_UNUSED
• Each element of pPreserveAttachments must not also be an element of any other member of the subpass description
• If any attachment is used by more than one AttachmentReference member, then each use must use the same layout
• If flags includes SUBPASS_DESCRIPTION_PER_VIEW_POSITION_X_ONLY_BIT_NVX, it must also include SUBPASS_DESCRIPTION_PER_VIEW_ATTRIBUTES_BIT_NVX
• If flags includes SUBPASS_DESCRIPTION_SHADER_RESOLVE_BIT_QCOM, and if pResolveAttachments is not NULL, then each resolve attachment must be ATTACHMENT_UNUSED
• If flags includes SUBPASS_DESCRIPTION_SHADER_RESOLVE_BIT_QCOM, and if pDepthStencilResolveAttachmentKHR is not NULL, then the depth/stencil resolve attachment must be ATTACHMENT_UNUSED
• If flags includes SUBPASS_DESCRIPTION_SHADER_RESOLVE_BIT_QCOM, then the subpass must be the last subpass in a subpass dependency chain
• If flags includes SUBPASS_DESCRIPTION_FRAGMENT_REGION_BIT_QCOM, then the sample count of the input attachments must equal rasterizationSamples
• If flags includes SUBPASS_DESCRIPTION_FRAGMENT_REGION_BIT_QCOM, and if sampleShadingEnable is enabled (explicitly or implicitly) then minSampleShading must equal 0.0
• If the render pass is created with RENDER_PASS_CREATE_TRANSFORM_BIT_QCOM each of the elements of pInputAttachments must be ATTACHMENT_UNUSED

Valid Usage (Implicit)

• flags must be a valid combination of SubpassDescriptionFlagBits values

• 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

• flags :: SubpassDescriptionFlags

  flags is a bitmask of SubpassDescriptionFlagBits specifying usage of the subpass.

• pipelineBindPoint :: PipelineBindPoint

  pipelineBindPoint is a PipelineBindPoint value specifying the pipeline type supported for this subpass.

• inputAttachments :: Vector AttachmentReference

  pInputAttachments is a pointer to an array of AttachmentReference structures defining the input attachments for this subpass and their layouts.

• colorAttachments :: Vector AttachmentReference

  pColorAttachments is a pointer to an array of AttachmentReference structures defining the color attachments for this subpass and their layouts.

• resolveAttachments :: Vector AttachmentReference

  pResolveAttachments is an optional array of colorAttachmentCount AttachmentReference structures defining the resolve attachments for this subpass and their layouts.

• depthStencilAttachment :: Maybe AttachmentReference

  pDepthStencilAttachment is a pointer to a AttachmentReference structure specifying the depth/stencil attachment for this subpass and its layout.

• preserveAttachments :: Vector Word32

  pPreserveAttachments is a pointer to an array of preserveAttachmentCount render pass attachment indices identifying attachments that are not used by this subpass, but whose contents must be preserved throughout the subpass.

Instances

Show SubpassDescription

Defined in Vulkan.Core10.Pass

Methods

showsPrec :: Int -> SubpassDescription -> ShowS

show :: SubpassDescription -> String

showList :: [SubpassDescription] -> ShowS

Generic SubpassDescription

Defined in Vulkan.Core10.Pass

Associated Types

type Rep SubpassDescription :: Type -> Type

Methods

from :: SubpassDescription -> Rep SubpassDescription x

to :: Rep SubpassDescription x -> SubpassDescription

FromCStruct SubpassDescription

Defined in Vulkan.Core10.Pass

Methods

peekCStruct :: Ptr SubpassDescription -> IO SubpassDescription

ToCStruct SubpassDescription

Defined in Vulkan.Core10.Pass

Methods

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

pokeCStruct :: Ptr SubpassDescription -> SubpassDescription -> IO b -> IO b

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

pokeZeroCStruct :: Ptr SubpassDescription -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

Zero SubpassDescription

Defined in Vulkan.Core10.Pass

Methods

zero :: SubpassDescription

type Rep SubpassDescription

Defined in Vulkan.Core10.Pass

type Rep SubpassDescription = D1 ('MetaData "SubpassDescription" "Vulkan.Core10.Pass" "vulkan-3.6.1-inplace" 'False) (C1 ('MetaCons "SubpassDescription" 'PrefixI 'True) ((S1 ('MetaSel ('Just "flags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 SubpassDescriptionFlags) :*: (S1 ('MetaSel ('Just "pipelineBindPoint") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 PipelineBindPoint) :*: S1 ('MetaSel ('Just "inputAttachments") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Vector AttachmentReference)))) :*: ((S1 ('MetaSel ('Just "colorAttachments") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Vector AttachmentReference)) :*: S1 ('MetaSel ('Just "resolveAttachments") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Vector AttachmentReference))) :*: (S1 ('MetaSel ('Just "depthStencilAttachment") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AttachmentReference)) :*: S1 ('MetaSel ('Just "preserveAttachments") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Vector Word32))))))

data SubpassDependency

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

• If the geometry shaders feature is not enabled, srcStageMask must not contain PIPELINE_STAGE_GEOMETRY_SHADER_BIT

• If the geometry shaders feature is not enabled, dstStageMask must not contain PIPELINE_STAGE_GEOMETRY_SHADER_BIT
• If the tessellation shaders feature is not enabled, srcStageMask must not contain PIPELINE_STAGE_TESSELLATION_CONTROL_SHADER_BIT or PIPELINE_STAGE_TESSELLATION_EVALUATION_SHADER_BIT
• If the tessellation shaders feature is not enabled, dstStageMask must not contain PIPELINE_STAGE_TESSELLATION_CONTROL_SHADER_BIT or PIPELINE_STAGE_TESSELLATION_EVALUATION_SHADER_BIT
• srcSubpass must be less than or equal to dstSubpass, unless one of them is SUBPASS_EXTERNAL, to avoid cyclic dependencies and ensure a valid execution order
• srcSubpass and dstSubpass must not both be equal to SUBPASS_EXTERNAL
• If srcSubpass is equal to dstSubpass and not all of the stages in srcStageMask and dstStageMask are framebuffer-space stages, the logically latest pipeline stage in srcStageMask must be logically earlier than or equal to the logically earliest pipeline stage in dstStageMask
• Any access flag included in srcAccessMask must be supported by one of the pipeline stages in srcStageMask, as specified in the table of supported access types
• Any access flag included in dstAccessMask must be supported by one of the pipeline stages in dstStageMask, as specified in the table of supported access types
• If srcSubpass equals dstSubpass, and srcStageMask and dstStageMask both include a framebuffer-space stage, then dependencyFlags must include DEPENDENCY_BY_REGION_BIT
• If dependencyFlags includes DEPENDENCY_VIEW_LOCAL_BIT, srcSubpass must not be equal to SUBPASS_EXTERNAL
• If dependencyFlags includes DEPENDENCY_VIEW_LOCAL_BIT, dstSubpass must not be equal to SUBPASS_EXTERNAL
• If srcSubpass equals dstSubpass and that subpass has more than one bit set in the view mask, then dependencyFlags must include DEPENDENCY_VIEW_LOCAL_BIT
• If the mesh shaders feature is not enabled, srcStageMask must not contain PIPELINE_STAGE_MESH_SHADER_BIT_NV
• If the task shaders feature is not enabled, srcStageMask must not contain PIPELINE_STAGE_TASK_SHADER_BIT_NV
• If the mesh shaders feature is not enabled, dstStageMask must not contain PIPELINE_STAGE_MESH_SHADER_BIT_NV
• If the task shaders feature is not enabled, dstStageMask must not contain PIPELINE_STAGE_TASK_SHADER_BIT_NV

Valid Usage (Implicit)

• srcStageMask must be a valid combination of PipelineStageFlagBits values

• srcStageMask must not be 0
• dstStageMask must be a valid combination of PipelineStageFlagBits values
• dstStageMask must not be 0
• srcAccessMask must be a valid combination of AccessFlagBits values
• dstAccessMask must be a valid combination of AccessFlagBits values
• dependencyFlags must be a valid combination of DependencyFlagBits values

See Also

AccessFlags, DependencyFlags, PipelineStageFlags, RenderPassCreateInfo

Constructors

SubpassDependency

Fields

• srcSubpass :: Word32

  srcSubpass is the subpass index of the first subpass in the dependency, or SUBPASS_EXTERNAL.

• dstSubpass :: Word32

  dstSubpass is the subpass index of the second subpass in the dependency, or SUBPASS_EXTERNAL.

• srcStageMask :: PipelineStageFlags

  srcStageMask is a bitmask of PipelineStageFlagBits specifying the source stage mask.

• dstStageMask :: PipelineStageFlags

  dstStageMask is a bitmask of PipelineStageFlagBits specifying the destination stage mask

• srcAccessMask :: AccessFlags

  srcAccessMask is a bitmask of AccessFlagBits specifying a source access mask.

• dstAccessMask :: AccessFlags

  dstAccessMask is a bitmask of AccessFlagBits specifying a destination access mask.

• dependencyFlags :: DependencyFlags

  dependencyFlags is a bitmask of DependencyFlagBits.

Instances

Eq SubpassDependency

Defined in Vulkan.Core10.Pass

Methods

(==) :: SubpassDependency -> SubpassDependency -> Bool

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

Show SubpassDependency

Defined in Vulkan.Core10.Pass

Methods

showsPrec :: Int -> SubpassDependency -> ShowS

show :: SubpassDependency -> String

showList :: [SubpassDependency] -> ShowS

Generic SubpassDependency

Defined in Vulkan.Core10.Pass

Associated Types

type Rep SubpassDependency :: Type -> Type

Methods

from :: SubpassDependency -> Rep SubpassDependency x

to :: Rep SubpassDependency x -> SubpassDependency

Storable SubpassDependency

Defined in Vulkan.Core10.Pass

Methods

sizeOf :: SubpassDependency -> Int

alignment :: SubpassDependency -> Int

peekElemOff :: Ptr SubpassDependency -> Int -> IO SubpassDependency

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

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

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

peek :: Ptr SubpassDependency -> IO SubpassDependency

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

FromCStruct SubpassDependency

Defined in Vulkan.Core10.Pass

Methods

peekCStruct :: Ptr SubpassDependency -> IO SubpassDependency

ToCStruct SubpassDependency

Defined in Vulkan.Core10.Pass

Methods

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

pokeCStruct :: Ptr SubpassDependency -> SubpassDependency -> IO b -> IO b

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

pokeZeroCStruct :: Ptr SubpassDependency -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

Zero SubpassDependency

Defined in Vulkan.Core10.Pass

Methods

zero :: SubpassDependency

type Rep SubpassDependency

Defined in Vulkan.Core10.Pass

type Rep SubpassDependency = D1 ('MetaData "SubpassDependency" "Vulkan.Core10.Pass" "vulkan-3.6.1-inplace" 'False) (C1 ('MetaCons "SubpassDependency" 'PrefixI 'True) ((S1 ('MetaSel ('Just "srcSubpass") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Word32) :*: (S1 ('MetaSel ('Just "dstSubpass") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Word32) :*: S1 ('MetaSel ('Just "srcStageMask") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 PipelineStageFlags))) :*: ((S1 ('MetaSel ('Just "dstStageMask") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 PipelineStageFlags) :*: S1 ('MetaSel ('Just "srcAccessMask") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 AccessFlags)) :*: (S1 ('MetaSel ('Just "dstAccessMask") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 AccessFlags) :*: S1 ('MetaSel ('Just "dependencyFlags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 DependencyFlags)))))

data RenderPassCreateInfo (es :: [Type])

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

• For any member of pAttachments with a loadOp equal to ATTACHMENT_LOAD_OP_CLEAR, the first use of that attachment must not specify a layout equal to IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL or IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL
• For any member of pAttachments with a stencilLoadOp equal to ATTACHMENT_LOAD_OP_CLEAR, the first use of that attachment must not specify a layout equal to IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL or IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL
• For any member of pAttachments with a loadOp equal to ATTACHMENT_LOAD_OP_CLEAR, the first use of that attachment must not specify a layout equal to IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL
• For any member of pAttachments with a stencilLoadOp equal to ATTACHMENT_LOAD_OP_CLEAR, the first use of that attachment must not specify a layout equal to IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL
• If the pNext chain includes a RenderPassInputAttachmentAspectCreateInfo structure, the subpass member of each element of its pAspectReferences member must be less than subpassCount
• If the pNext chain includes a RenderPassInputAttachmentAspectCreateInfo structure, the inputAttachmentIndex member of each element of its pAspectReferences member must be less than the value of inputAttachmentCount in the member of pSubpasses identified by its subpass member
• If the pNext chain includes a RenderPassInputAttachmentAspectCreateInfo structure, for any element of the pInputAttachments member of any element of pSubpasses where the attachment member is not ATTACHMENT_UNUSED, the aspectMask member of the corresponding element of RenderPassInputAttachmentAspectCreateInfo::pAspectReferences must only include aspects that are present in images of the format specified by the element of pAttachments at attachment
• If the pNext chain includes a RenderPassMultiviewCreateInfo structure, and its subpassCount member is not zero, that member must be equal to the value of subpassCount
• If the pNext chain includes a RenderPassMultiviewCreateInfo structure, if its dependencyCount member is not zero, it must be equal to dependencyCount
• If the pNext chain includes a RenderPassMultiviewCreateInfo structure, for each non-zero element of pViewOffsets, the srcSubpass and dstSubpass members of pDependencies at the same index must not be equal
• If the pNext chain includes a RenderPassMultiviewCreateInfo structure, for any element of pDependencies with a dependencyFlags member that does not include DEPENDENCY_VIEW_LOCAL_BIT, the corresponding element of the pViewOffsets member of that RenderPassMultiviewCreateInfo instance must be 0
• If the pNext chain includes a RenderPassMultiviewCreateInfo structure, elements of its pViewMasks member must either all be 0, or all not be 0
• If the pNext chain includes a RenderPassMultiviewCreateInfo structure, and each element of its pViewMasks member is 0, the dependencyFlags member of each element of pDependencies must not include DEPENDENCY_VIEW_LOCAL_BIT
• If the pNext chain includes a RenderPassMultiviewCreateInfo structure, and each element of its pViewMasks member is 0, correlatedViewMaskCount must be 0
• If the pNext chain includes a RenderPassMultiviewCreateInfo structure, each element of its pViewMask member must not have a bit set at an index greater than or equal to PhysicalDeviceLimits::maxFramebufferLayers
• For any element of pDependencies, if the srcSubpass is not SUBPASS_EXTERNAL, all stage flags included in the srcStageMask member of that dependency must be a pipeline stage supported by the pipeline identified by the pipelineBindPoint member of the source subpass
• For any element of pDependencies, if the dstSubpass is not SUBPASS_EXTERNAL, all stage flags included in the dstStageMask member of that dependency must be a pipeline stage supported by the pipeline identified by the pipelineBindPoint member of the destination subpass
• The srcSubpass member of each element of pDependencies must be less than subpassCount
• The dstSubpass member of each element of pDependencies must be less than subpassCount

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_RENDER_PASS_CREATE_INFO

• Each pNext member of any structure (including this one) in the pNext chain must be either NULL or a pointer to a valid instance of RenderPassFragmentDensityMapCreateInfoEXT, RenderPassInputAttachmentAspectCreateInfo, or RenderPassMultiviewCreateInfo
• The sType value of each struct in the pNext chain must be unique
• flags must be a valid combination of RenderPassCreateFlagBits values
• If attachmentCount is not 0, pAttachments must be a valid pointer to an array of attachmentCount valid AttachmentDescription structures
• pSubpasses must be a valid pointer to an array of subpassCount valid SubpassDescription structures
• If dependencyCount is not 0, pDependencies must be a valid pointer to an array of dependencyCount valid SubpassDependency structures
• subpassCount must be greater than 0

See Also

AttachmentDescription, RenderPassCreateFlags, StructureType, SubpassDependency, SubpassDescription, createRenderPass

Constructors

RenderPassCreateInfo

Fields

• next :: Chain es

  pNext is NULL or a pointer to a structure extending this structure.

• flags :: RenderPassCreateFlags

  flags is a bitmask of RenderPassCreateFlagBits

• attachments :: Vector AttachmentDescription

  pAttachments is a pointer to an array of attachmentCount AttachmentDescription structures describing the attachments used by the render pass.

• subpasses :: Vector SubpassDescription

  pSubpasses is a pointer to an array of subpassCount SubpassDescription structures describing each subpass.

• dependencies :: Vector SubpassDependency

  pDependencies is a pointer to an array of dependencyCount SubpassDependency structures describing dependencies between pairs of subpasses.

Instances

Extensible RenderPassCreateInfo

Defined in Vulkan.Core10.Pass

Methods

extensibleType :: StructureType

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

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

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

Show (Chain es) => Show (RenderPassCreateInfo es)

Defined in Vulkan.Core10.Pass

Methods

showsPrec :: Int -> RenderPassCreateInfo es -> ShowS

show :: RenderPassCreateInfo es -> String

showList :: [RenderPassCreateInfo es] -> ShowS

Generic (RenderPassCreateInfo es)

Defined in Vulkan.Core10.Pass

Associated Types

type Rep (RenderPassCreateInfo es) :: Type -> Type

Methods

from :: RenderPassCreateInfo es -> Rep (RenderPassCreateInfo es) x

to :: Rep (RenderPassCreateInfo es) x -> RenderPassCreateInfo es

(Extendss RenderPassCreateInfo es, PeekChain es) => FromCStruct (RenderPassCreateInfo es)

Defined in Vulkan.Core10.Pass

Methods

peekCStruct :: Ptr (RenderPassCreateInfo es) -> IO (RenderPassCreateInfo es)

(Extendss RenderPassCreateInfo es, PokeChain es) => ToCStruct (RenderPassCreateInfo es)

Defined in Vulkan.Core10.Pass

Methods

withCStruct :: RenderPassCreateInfo es -> (Ptr (RenderPassCreateInfo es) -> IO b) -> IO b

pokeCStruct :: Ptr (RenderPassCreateInfo es) -> RenderPassCreateInfo es -> IO b -> IO b

withZeroCStruct :: (Ptr (RenderPassCreateInfo es) -> IO b) -> IO b

pokeZeroCStruct :: Ptr (RenderPassCreateInfo es) -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

es ~ ('[] :: [Type]) => Zero (RenderPassCreateInfo es)

Defined in Vulkan.Core10.Pass

Methods

zero :: RenderPassCreateInfo es

type Rep (RenderPassCreateInfo es)

Defined in Vulkan.Core10.Pass

type Rep (RenderPassCreateInfo es) = D1 ('MetaData "RenderPassCreateInfo" "Vulkan.Core10.Pass" "vulkan-3.6.1-inplace" 'False) (C1 ('MetaCons "RenderPassCreateInfo" 'PrefixI 'True) ((S1 ('MetaSel ('Just "next") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Chain es)) :*: S1 ('MetaSel ('Just "flags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 RenderPassCreateFlags)) :*: (S1 ('MetaSel ('Just "attachments") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Vector AttachmentDescription)) :*: (S1 ('MetaSel ('Just "subpasses") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Vector SubpassDescription)) :*: S1 ('MetaSel ('Just "dependencies") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Vector SubpassDependency))))))

data FramebufferCreateInfo (es :: [Type])

VkFramebufferCreateInfo - Structure specifying parameters of a newly created framebuffer

Description

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.

For depth/stencil attachments, each aspect can be used separately as attachments and non-attachments as long as the non-attachment accesses are also via an image subresource in either the IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL layout or the IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL layout, and the attachment resource uses whichever of those two layouts the image accesses do not. Use of non-attachment aspects in this case 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 must have dimensions at least as large as the corresponding framebuffer dimension except for any element that is referenced by fragmentDensityMapAttachment
• If renderPass was specified with non-zero view masks, each element of pAttachments that is not referenced by fragmentDensityMapAttachment 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, each element of pAttachments must only specify a single mip level
• If flags does not include FRAMEBUFFER_CREATE_IMAGELESS_BIT, each element of pAttachments must have been created with the identity swizzle
• width must be greater than 0
• width must be less than or equal to PhysicalDeviceLimits::maxFramebufferWidth
• height must be greater than 0
• height must be less than or equal to PhysicalDeviceLimits::maxFramebufferHeight
• layers must be greater than 0
• layers must be less than or equal to PhysicalDeviceLimits::maxFramebufferLayers
• If renderPass was specified with non-zero view masks, layers must be 1
• If flags does not include FRAMEBUFFER_CREATE_IMAGELESS_BIT, each element of pAttachments that is a 2D or 2D array image view taken from a 3D image must not be a depth/stencil format
• If the imageless framebuffer feature is not enabled, flags must not include FRAMEBUFFER_CREATE_IMAGELESS_BIT
• If flags includes FRAMEBUFFER_CREATE_IMAGELESS_BIT, the pNext chain must include a FramebufferAttachmentsCreateInfo structure
• If flags includes FRAMEBUFFER_CREATE_IMAGELESS_BIT, the attachmentImageInfoCount member of a FramebufferAttachmentsCreateInfo structure included in the pNext chain must be equal to either zero or attachmentCount
• If flags includes FRAMEBUFFER_CREATE_IMAGELESS_BIT, the width member of any element of the pAttachmentImageInfos member of a FramebufferAttachmentsCreateInfo structure included in the pNext chain must be greater than or equal to width, except for any element that is referenced by RenderPassFragmentDensityMapCreateInfoEXT::fragmentDensityMapAttachment in renderPass
• If flags includes FRAMEBUFFER_CREATE_IMAGELESS_BIT, the height member of any element of the pAttachmentImageInfos member of a FramebufferAttachmentsCreateInfo structure included in the pNext chain must be greater than or equal to height, except for any element that is referenced by RenderPassFragmentDensityMapCreateInfoEXT::fragmentDensityMapAttachment in renderPass
• If flags includes FRAMEBUFFER_CREATE_IMAGELESS_BIT, the width member of any element of the pAttachmentImageInfos member of a FramebufferAttachmentsCreateInfo structure included in the pNext chain that is referenced by RenderPassFragmentDensityMapCreateInfoEXT::fragmentDensityMapAttachment in renderPass must be greater than or equal to \(\left\lceil{\frac{width}{maxFragmentDensityTexelSize_{width}}}\right\rceil\)
• If flags includes FRAMEBUFFER_CREATE_IMAGELESS_BIT, the height member of any element of the pAttachmentImageInfos member of a FramebufferAttachmentsCreateInfo structure included in the pNext chain that is referenced by RenderPassFragmentDensityMapCreateInfoEXT::fragmentDensityMapAttachment in renderPass must be greater than or equal to \(\left\lceil{\frac{height}{maxFragmentDensityTexelSize_{height}}}\right\rceil\)
• If multiview is enabled for renderPass, and flags includes FRAMEBUFFER_CREATE_IMAGELESS_BIT, the layerCount member of any element of the pAttachmentImageInfos member of a FramebufferAttachmentsCreateInfo structure included in the pNext chain must be greater than the maximum bit index set in the view mask in the subpasses in which it is used in renderPass
• If multiview is not enabled for renderPass, and flags includes FRAMEBUFFER_CREATE_IMAGELESS_BIT, the layerCount member of any element of the pAttachmentImageInfos member of a FramebufferAttachmentsCreateInfo structure included in the pNext chain must be greater than or equal to layers
• If flags includes FRAMEBUFFER_CREATE_IMAGELESS_BIT, the usage member of any element of the pAttachmentImageInfos member of a FramebufferAttachmentsCreateInfo structure included in the pNext chain that refers to an attachment used as a color attachment or resolve attachment by renderPass must include IMAGE_USAGE_COLOR_ATTACHMENT_BIT
• If flags includes FRAMEBUFFER_CREATE_IMAGELESS_BIT, the usage member of any element of the pAttachmentImageInfos member of a FramebufferAttachmentsCreateInfo structure included in the pNext chain that refers to an attachment used as a depth/stencil attachment by renderPass must include IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT
• If flags includes FRAMEBUFFER_CREATE_IMAGELESS_BIT, the usage member of any element of the pAttachmentImageInfos member of a FramebufferAttachmentsCreateInfo structure included in the pNext chain that refers to an attachment used as a depth/stencil resolve attachment by renderPass must include IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT
• If flags includes FRAMEBUFFER_CREATE_IMAGELESS_BIT, the usage member of any element of the pAttachmentImageInfos member of a FramebufferAttachmentsCreateInfo structure included in the pNext chain that refers to an attachment used as an input attachment by renderPass must include IMAGE_USAGE_INPUT_ATTACHMENT_BIT
• If flags includes FRAMEBUFFER_CREATE_IMAGELESS_BIT, at least one element of the pViewFormats member of any element of the pAttachmentImageInfos member of a FramebufferAttachmentsCreateInfo structure included in the pNext chain must be equal to the corresponding value of AttachmentDescription::format used to create renderPass
• If flags does not include FRAMEBUFFER_CREATE_IMAGELESS_BIT, each element of pAttachments must have been created with ImageViewCreateInfo::viewType not equal to IMAGE_VIEW_TYPE_3D

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_FRAMEBUFFER_CREATE_INFO

• pNext must be NULL or a pointer to a valid instance of FramebufferAttachmentsCreateInfo
• The sType value of each struct in the pNext chain must be unique
• flags must be a valid combination of FramebufferCreateFlagBits values
• renderPass must be a valid RenderPass handle
• Both of renderPass, and the elements of pAttachments that are valid handles of non-ignored parameters must have been created, allocated, or retrieved from the same Device

See Also

FramebufferCreateFlags, ImageView, RenderPass, StructureType, createFramebuffer

Constructors

FramebufferCreateInfo

Fields

• next :: Chain es

  pNext is NULL or a pointer to a structure extending this structure.

• flags :: FramebufferCreateFlags

  flags is a bitmask of FramebufferCreateFlagBits

• renderPass :: RenderPass

  renderPass is a render pass defining what render passes the framebuffer will be compatible with. See Render Pass Compatibility for details.

• attachments :: Vector ImageView

  pAttachments is a pointer to an array of ImageView handles, each of which will be used as the corresponding attachment in a render pass instance. If flags includes FRAMEBUFFER_CREATE_IMAGELESS_BIT, this parameter is ignored.

• width :: Word32

  width, height and layers define the dimensions of the framebuffer. If the render pass uses multiview, then layers must be one and each attachment requires a number of layers that is greater than the maximum bit index set in the view mask in the subpasses in which it is used.

• height :: Word32
• layers :: Word32

Instances

Extensible FramebufferCreateInfo

Defined in Vulkan.Core10.Pass

Methods

extensibleType :: StructureType

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

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

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

Show (Chain es) => Show (FramebufferCreateInfo es)

Defined in Vulkan.Core10.Pass

Methods

showsPrec :: Int -> FramebufferCreateInfo es -> ShowS

show :: FramebufferCreateInfo es -> String

showList :: [FramebufferCreateInfo es] -> ShowS

Generic (FramebufferCreateInfo es)

Defined in Vulkan.Core10.Pass

Associated Types

type Rep (FramebufferCreateInfo es) :: Type -> Type

Methods

from :: FramebufferCreateInfo es -> Rep (FramebufferCreateInfo es) x

to :: Rep (FramebufferCreateInfo es) x -> FramebufferCreateInfo es

(Extendss FramebufferCreateInfo es, PeekChain es) => FromCStruct (FramebufferCreateInfo es)

Defined in Vulkan.Core10.Pass

Methods

peekCStruct :: Ptr (FramebufferCreateInfo es) -> IO (FramebufferCreateInfo es)

(Extendss FramebufferCreateInfo es, PokeChain es) => ToCStruct (FramebufferCreateInfo es)

Defined in Vulkan.Core10.Pass

Methods

withCStruct :: FramebufferCreateInfo es -> (Ptr (FramebufferCreateInfo es) -> IO b) -> IO b

pokeCStruct :: Ptr (FramebufferCreateInfo es) -> FramebufferCreateInfo es -> IO b -> IO b

withZeroCStruct :: (Ptr (FramebufferCreateInfo es) -> IO b) -> IO b

pokeZeroCStruct :: Ptr (FramebufferCreateInfo es) -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

es ~ ('[] :: [Type]) => Zero (FramebufferCreateInfo es)

Defined in Vulkan.Core10.Pass

Methods

zero :: FramebufferCreateInfo es

type Rep (FramebufferCreateInfo es)

Defined in Vulkan.Core10.Pass

type Rep (FramebufferCreateInfo es) = D1 ('MetaData "FramebufferCreateInfo" "Vulkan.Core10.Pass" "vulkan-3.6.1-inplace" 'False) (C1 ('MetaCons "FramebufferCreateInfo" 'PrefixI 'True) ((S1 ('MetaSel ('Just "next") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Chain es)) :*: (S1 ('MetaSel ('Just "flags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 FramebufferCreateFlags) :*: S1 ('MetaSel ('Just "renderPass") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 RenderPass))) :*: ((S1 ('MetaSel ('Just "attachments") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Vector ImageView)) :*: S1 ('MetaSel ('Just "width") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Word32)) :*: (S1 ('MetaSel ('Just "height") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Word32) :*: S1 ('MetaSel ('Just "layers") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Word32)))))

newtype Framebuffer

VkFramebuffer - Opaque handle to a framebuffer object

See Also

CommandBufferInheritanceInfo, RenderPassBeginInfo, createFramebuffer, destroyFramebuffer

Constructors

Framebuffer Word64

Instances

Eq Framebuffer

Defined in Vulkan.Core10.Handles

Methods

(==) :: Framebuffer -> Framebuffer -> Bool

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

Ord Framebuffer

Defined in Vulkan.Core10.Handles

Methods

compare :: Framebuffer -> Framebuffer -> Ordering

(<) :: Framebuffer -> Framebuffer -> Bool

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

(>) :: Framebuffer -> Framebuffer -> Bool

(>=) :: Framebuffer -> Framebuffer -> Bool

max :: Framebuffer -> Framebuffer -> Framebuffer

min :: Framebuffer -> Framebuffer -> Framebuffer

Show Framebuffer

Defined in Vulkan.Core10.Handles

Methods

showsPrec :: Int -> Framebuffer -> ShowS

show :: Framebuffer -> String

showList :: [Framebuffer] -> ShowS

Storable Framebuffer

Defined in Vulkan.Core10.Handles

Methods

sizeOf :: Framebuffer -> Int

alignment :: Framebuffer -> Int

peekElemOff :: Ptr Framebuffer -> Int -> IO Framebuffer

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

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

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

peek :: Ptr Framebuffer -> IO Framebuffer

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

Zero Framebuffer

Defined in Vulkan.Core10.Handles

Methods

zero :: Framebuffer

HasObjectType Framebuffer

Defined in Vulkan.Core10.Handles

Methods

objectTypeAndHandle :: Framebuffer -> (ObjectType, Word64)

IsHandle Framebuffer

Defined in Vulkan.Core10.Handles

newtype RenderPass

VkRenderPass - Opaque handle to a render pass object

See Also

CommandBufferInheritanceInfo, FramebufferCreateInfo, GraphicsPipelineCreateInfo, RenderPassBeginInfo, createRenderPass, createRenderPass2, createRenderPass2KHR, destroyRenderPass, getRenderAreaGranularity

Constructors

RenderPass Word64

Instances

Eq RenderPass

Defined in Vulkan.Core10.Handles

Methods

(==) :: RenderPass -> RenderPass -> Bool

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

Ord RenderPass

Defined in Vulkan.Core10.Handles

Methods

compare :: RenderPass -> RenderPass -> Ordering

(<) :: RenderPass -> RenderPass -> Bool

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

(>) :: RenderPass -> RenderPass -> Bool

(>=) :: RenderPass -> RenderPass -> Bool

max :: RenderPass -> RenderPass -> RenderPass

min :: RenderPass -> RenderPass -> RenderPass

Show RenderPass

Defined in Vulkan.Core10.Handles

Methods

showsPrec :: Int -> RenderPass -> ShowS

show :: RenderPass -> String

showList :: [RenderPass] -> ShowS

Storable RenderPass

Defined in Vulkan.Core10.Handles

Methods

sizeOf :: RenderPass -> Int

alignment :: RenderPass -> Int

peekElemOff :: Ptr RenderPass -> Int -> IO RenderPass

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

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

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

peek :: Ptr RenderPass -> IO RenderPass

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

Zero RenderPass

Defined in Vulkan.Core10.Handles

Methods

zero :: RenderPass

HasObjectType RenderPass

Defined in Vulkan.Core10.Handles

Methods

objectTypeAndHandle :: RenderPass -> (ObjectType, Word64)

IsHandle RenderPass

Defined in Vulkan.Core10.Handles

newtype AttachmentLoadOp

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

Eq AttachmentLoadOp

Defined in Vulkan.Core10.Enums.AttachmentLoadOp

Methods

(==) :: AttachmentLoadOp -> AttachmentLoadOp -> Bool

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

Ord AttachmentLoadOp

Defined in Vulkan.Core10.Enums.AttachmentLoadOp

Methods

compare :: AttachmentLoadOp -> AttachmentLoadOp -> Ordering

(<) :: AttachmentLoadOp -> AttachmentLoadOp -> Bool

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

(>) :: AttachmentLoadOp -> AttachmentLoadOp -> Bool

(>=) :: AttachmentLoadOp -> AttachmentLoadOp -> Bool

max :: AttachmentLoadOp -> AttachmentLoadOp -> AttachmentLoadOp

min :: AttachmentLoadOp -> AttachmentLoadOp -> AttachmentLoadOp

Read AttachmentLoadOp

Defined in Vulkan.Core10.Enums.AttachmentLoadOp

Methods

readsPrec :: Int -> ReadS AttachmentLoadOp

readList :: ReadS [AttachmentLoadOp]

readPrec :: ReadPrec AttachmentLoadOp

readListPrec :: ReadPrec [AttachmentLoadOp]

Show AttachmentLoadOp

Defined in Vulkan.Core10.Enums.AttachmentLoadOp

Methods

showsPrec :: Int -> AttachmentLoadOp -> ShowS

show :: AttachmentLoadOp -> String

showList :: [AttachmentLoadOp] -> ShowS

Storable AttachmentLoadOp

Defined in Vulkan.Core10.Enums.AttachmentLoadOp

Methods

sizeOf :: AttachmentLoadOp -> Int

alignment :: AttachmentLoadOp -> Int

peekElemOff :: Ptr AttachmentLoadOp -> Int -> IO AttachmentLoadOp

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

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

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

peek :: Ptr AttachmentLoadOp -> IO AttachmentLoadOp

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

Zero AttachmentLoadOp

Defined in Vulkan.Core10.Enums.AttachmentLoadOp

Methods

zero :: AttachmentLoadOp

newtype AttachmentStoreOp

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

Eq AttachmentStoreOp

Defined in Vulkan.Core10.Enums.AttachmentStoreOp

Methods

(==) :: AttachmentStoreOp -> AttachmentStoreOp -> Bool

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

Ord AttachmentStoreOp

Defined in Vulkan.Core10.Enums.AttachmentStoreOp

Methods

compare :: AttachmentStoreOp -> AttachmentStoreOp -> Ordering

(<) :: AttachmentStoreOp -> AttachmentStoreOp -> Bool

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

(>) :: AttachmentStoreOp -> AttachmentStoreOp -> Bool

(>=) :: AttachmentStoreOp -> AttachmentStoreOp -> Bool

max :: AttachmentStoreOp -> AttachmentStoreOp -> AttachmentStoreOp

min :: AttachmentStoreOp -> AttachmentStoreOp -> AttachmentStoreOp

Read AttachmentStoreOp

Defined in Vulkan.Core10.Enums.AttachmentStoreOp

Methods

readsPrec :: Int -> ReadS AttachmentStoreOp

readList :: ReadS [AttachmentStoreOp]

readPrec :: ReadPrec AttachmentStoreOp

readListPrec :: ReadPrec [AttachmentStoreOp]

Show AttachmentStoreOp

Defined in Vulkan.Core10.Enums.AttachmentStoreOp

Methods

showsPrec :: Int -> AttachmentStoreOp -> ShowS

show :: AttachmentStoreOp -> String

showList :: [AttachmentStoreOp] -> ShowS

Storable AttachmentStoreOp

Defined in Vulkan.Core10.Enums.AttachmentStoreOp

Methods

sizeOf :: AttachmentStoreOp -> Int

alignment :: AttachmentStoreOp -> Int

peekElemOff :: Ptr AttachmentStoreOp -> Int -> IO AttachmentStoreOp

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

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

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

peek :: Ptr AttachmentStoreOp -> IO AttachmentStoreOp

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

Zero AttachmentStoreOp

Defined in Vulkan.Core10.Enums.AttachmentStoreOp

Methods

zero :: AttachmentStoreOp

newtype PipelineBindPoint

VkPipelineBindPoint - Specify the bind point of a pipeline object to a command buffer

See Also

DescriptorUpdateTemplateCreateInfo, GeneratedCommandsInfoNV, GeneratedCommandsMemoryRequirementsInfoNV, IndirectCommandsLayoutCreateInfoNV, SubpassDescription, SubpassDescription2, cmdBindDescriptorSets, cmdBindPipeline, cmdBindPipelineShaderGroupNV, cmdPushDescriptorSetKHR

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

Eq PipelineBindPoint

Defined in Vulkan.Core10.Enums.PipelineBindPoint

Methods

(==) :: PipelineBindPoint -> PipelineBindPoint -> Bool

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

Ord PipelineBindPoint

Defined in Vulkan.Core10.Enums.PipelineBindPoint

Methods

compare :: PipelineBindPoint -> PipelineBindPoint -> Ordering

(<) :: PipelineBindPoint -> PipelineBindPoint -> Bool

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

(>) :: PipelineBindPoint -> PipelineBindPoint -> Bool

(>=) :: PipelineBindPoint -> PipelineBindPoint -> Bool

max :: PipelineBindPoint -> PipelineBindPoint -> PipelineBindPoint

min :: PipelineBindPoint -> PipelineBindPoint -> PipelineBindPoint

Read PipelineBindPoint

Defined in Vulkan.Core10.Enums.PipelineBindPoint

Methods

readsPrec :: Int -> ReadS PipelineBindPoint

readList :: ReadS [PipelineBindPoint]

readPrec :: ReadPrec PipelineBindPoint

readListPrec :: ReadPrec [PipelineBindPoint]

Show PipelineBindPoint

Defined in Vulkan.Core10.Enums.PipelineBindPoint

Methods

showsPrec :: Int -> PipelineBindPoint -> ShowS

show :: PipelineBindPoint -> String

showList :: [PipelineBindPoint] -> ShowS

Storable PipelineBindPoint

Defined in Vulkan.Core10.Enums.PipelineBindPoint

Methods

sizeOf :: PipelineBindPoint -> Int

alignment :: PipelineBindPoint -> Int

peekElemOff :: Ptr PipelineBindPoint -> Int -> IO PipelineBindPoint

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

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

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

peek :: Ptr PipelineBindPoint -> IO PipelineBindPoint

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

Zero PipelineBindPoint

Defined in Vulkan.Core10.Enums.PipelineBindPoint

Methods

zero :: PipelineBindPoint

newtype RenderPassCreateFlagBits

VkRenderPassCreateFlagBits - Bitmask specifying additional properties of a renderpass

See Also

RenderPassCreateFlags

Constructors

RenderPassCreateFlagBits Flags

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

Eq RenderPassCreateFlagBits

Defined in Vulkan.Core10.Enums.RenderPassCreateFlagBits

Methods

(==) :: RenderPassCreateFlagBits -> RenderPassCreateFlagBits -> Bool

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

Ord RenderPassCreateFlagBits

Defined in Vulkan.Core10.Enums.RenderPassCreateFlagBits

Methods

compare :: RenderPassCreateFlagBits -> RenderPassCreateFlagBits -> Ordering

(<) :: RenderPassCreateFlagBits -> RenderPassCreateFlagBits -> Bool

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

(>) :: RenderPassCreateFlagBits -> RenderPassCreateFlagBits -> Bool

(>=) :: RenderPassCreateFlagBits -> RenderPassCreateFlagBits -> Bool

max :: RenderPassCreateFlagBits -> RenderPassCreateFlagBits -> RenderPassCreateFlagBits

min :: RenderPassCreateFlagBits -> RenderPassCreateFlagBits -> RenderPassCreateFlagBits

Read RenderPassCreateFlagBits

Defined in Vulkan.Core10.Enums.RenderPassCreateFlagBits

Methods

readsPrec :: Int -> ReadS RenderPassCreateFlagBits

readList :: ReadS [RenderPassCreateFlagBits]

readPrec :: ReadPrec RenderPassCreateFlagBits

readListPrec :: ReadPrec [RenderPassCreateFlagBits]

Show RenderPassCreateFlagBits

Defined in Vulkan.Core10.Enums.RenderPassCreateFlagBits

Methods

showsPrec :: Int -> RenderPassCreateFlagBits -> ShowS

show :: RenderPassCreateFlagBits -> String

showList :: [RenderPassCreateFlagBits] -> ShowS

Storable RenderPassCreateFlagBits

Defined in Vulkan.Core10.Enums.RenderPassCreateFlagBits

Methods

sizeOf :: RenderPassCreateFlagBits -> Int

alignment :: RenderPassCreateFlagBits -> Int

peekElemOff :: Ptr RenderPassCreateFlagBits -> Int -> IO RenderPassCreateFlagBits

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

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

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

peek :: Ptr RenderPassCreateFlagBits -> IO RenderPassCreateFlagBits

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

Bits RenderPassCreateFlagBits

Defined in Vulkan.Core10.Enums.RenderPassCreateFlagBits

Methods

(.&.) :: RenderPassCreateFlagBits -> RenderPassCreateFlagBits -> RenderPassCreateFlagBits

(.|.) :: RenderPassCreateFlagBits -> RenderPassCreateFlagBits -> RenderPassCreateFlagBits

xor :: RenderPassCreateFlagBits -> RenderPassCreateFlagBits -> RenderPassCreateFlagBits

complement :: RenderPassCreateFlagBits -> RenderPassCreateFlagBits

shift :: RenderPassCreateFlagBits -> Int -> RenderPassCreateFlagBits

rotate :: RenderPassCreateFlagBits -> Int -> RenderPassCreateFlagBits

zeroBits :: RenderPassCreateFlagBits

bit :: Int -> RenderPassCreateFlagBits

setBit :: RenderPassCreateFlagBits -> Int -> RenderPassCreateFlagBits

clearBit :: RenderPassCreateFlagBits -> Int -> RenderPassCreateFlagBits

complementBit :: RenderPassCreateFlagBits -> Int -> RenderPassCreateFlagBits

testBit :: RenderPassCreateFlagBits -> Int -> Bool

bitSizeMaybe :: RenderPassCreateFlagBits -> Maybe Int

bitSize :: RenderPassCreateFlagBits -> Int

isSigned :: RenderPassCreateFlagBits -> Bool

shiftL :: RenderPassCreateFlagBits -> Int -> RenderPassCreateFlagBits

unsafeShiftL :: RenderPassCreateFlagBits -> Int -> RenderPassCreateFlagBits

shiftR :: RenderPassCreateFlagBits -> Int -> RenderPassCreateFlagBits

unsafeShiftR :: RenderPassCreateFlagBits -> Int -> RenderPassCreateFlagBits

rotateL :: RenderPassCreateFlagBits -> Int -> RenderPassCreateFlagBits

rotateR :: RenderPassCreateFlagBits -> Int -> RenderPassCreateFlagBits

popCount :: RenderPassCreateFlagBits -> Int

Zero RenderPassCreateFlagBits

Defined in Vulkan.Core10.Enums.RenderPassCreateFlagBits

Methods

zero :: RenderPassCreateFlagBits

type RenderPassCreateFlags = RenderPassCreateFlagBits

newtype AccessFlagBits

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
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_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
ACCESS_TRANSFER_WRITE_BIT	PIPELINE_STAGE_TRANSFER_BIT
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_SHADING_RATE_IMAGE_READ_BIT_NV	PIPELINE_STAGE_SHADING_RATE_IMAGE_BIT_NV
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_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 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

ACCESS_SHADING_RATE_IMAGE_READ_BIT_NV specifies read access to a shading rate image as part of a drawing command, as bound by cmdBindShadingRateImageNV.

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 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 or build 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

Eq AccessFlagBits

Defined in Vulkan.Core10.Enums.AccessFlagBits

Methods

(==) :: AccessFlagBits -> AccessFlagBits -> Bool

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

Ord AccessFlagBits

Defined in Vulkan.Core10.Enums.AccessFlagBits

Methods

compare :: AccessFlagBits -> AccessFlagBits -> Ordering

(<) :: AccessFlagBits -> AccessFlagBits -> Bool

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

(>) :: AccessFlagBits -> AccessFlagBits -> Bool

(>=) :: AccessFlagBits -> AccessFlagBits -> Bool

max :: AccessFlagBits -> AccessFlagBits -> AccessFlagBits

min :: AccessFlagBits -> AccessFlagBits -> AccessFlagBits

Read AccessFlagBits

Defined in Vulkan.Core10.Enums.AccessFlagBits

Methods

readsPrec :: Int -> ReadS AccessFlagBits

readList :: ReadS [AccessFlagBits]

readPrec :: ReadPrec AccessFlagBits

readListPrec :: ReadPrec [AccessFlagBits]

Show AccessFlagBits

Defined in Vulkan.Core10.Enums.AccessFlagBits

Methods

showsPrec :: Int -> AccessFlagBits -> ShowS

show :: AccessFlagBits -> String

showList :: [AccessFlagBits] -> ShowS

Storable AccessFlagBits

Defined in Vulkan.Core10.Enums.AccessFlagBits

Methods

sizeOf :: AccessFlagBits -> Int

alignment :: AccessFlagBits -> Int

peekElemOff :: Ptr AccessFlagBits -> Int -> IO AccessFlagBits

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

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

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

peek :: Ptr AccessFlagBits -> IO AccessFlagBits

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

Bits AccessFlagBits

Defined in Vulkan.Core10.Enums.AccessFlagBits

Methods

(.&.) :: AccessFlagBits -> AccessFlagBits -> AccessFlagBits

(.|.) :: AccessFlagBits -> AccessFlagBits -> AccessFlagBits

xor :: AccessFlagBits -> AccessFlagBits -> AccessFlagBits

complement :: AccessFlagBits -> AccessFlagBits

shift :: AccessFlagBits -> Int -> AccessFlagBits

rotate :: AccessFlagBits -> Int -> AccessFlagBits

zeroBits :: AccessFlagBits

bit :: Int -> AccessFlagBits

setBit :: AccessFlagBits -> Int -> AccessFlagBits

clearBit :: AccessFlagBits -> Int -> AccessFlagBits

complementBit :: AccessFlagBits -> Int -> AccessFlagBits

testBit :: AccessFlagBits -> Int -> Bool

bitSizeMaybe :: AccessFlagBits -> Maybe Int

bitSize :: AccessFlagBits -> Int

isSigned :: AccessFlagBits -> Bool

shiftL :: AccessFlagBits -> Int -> AccessFlagBits

unsafeShiftL :: AccessFlagBits -> Int -> AccessFlagBits

shiftR :: AccessFlagBits -> Int -> AccessFlagBits

unsafeShiftR :: AccessFlagBits -> Int -> AccessFlagBits

rotateL :: AccessFlagBits -> Int -> AccessFlagBits

rotateR :: AccessFlagBits -> Int -> AccessFlagBits

popCount :: AccessFlagBits -> Int

Zero AccessFlagBits

Defined in Vulkan.Core10.Enums.AccessFlagBits

Methods

zero :: AccessFlagBits

type AccessFlags = AccessFlagBits

newtype AttachmentDescriptionFlagBits

VkAttachmentDescriptionFlagBits - Bitmask specifying additional properties of an attachment

See Also

AttachmentDescriptionFlags

Constructors

AttachmentDescriptionFlagBits Flags

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

Eq AttachmentDescriptionFlagBits

Defined in Vulkan.Core10.Enums.AttachmentDescriptionFlagBits

Methods

(==) :: AttachmentDescriptionFlagBits -> AttachmentDescriptionFlagBits -> Bool

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

Ord AttachmentDescriptionFlagBits

Defined in Vulkan.Core10.Enums.AttachmentDescriptionFlagBits

Methods

compare :: AttachmentDescriptionFlagBits -> AttachmentDescriptionFlagBits -> Ordering

(<) :: AttachmentDescriptionFlagBits -> AttachmentDescriptionFlagBits -> Bool

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

(>) :: AttachmentDescriptionFlagBits -> AttachmentDescriptionFlagBits -> Bool

(>=) :: AttachmentDescriptionFlagBits -> AttachmentDescriptionFlagBits -> Bool

max :: AttachmentDescriptionFlagBits -> AttachmentDescriptionFlagBits -> AttachmentDescriptionFlagBits

min :: AttachmentDescriptionFlagBits -> AttachmentDescriptionFlagBits -> AttachmentDescriptionFlagBits

Read AttachmentDescriptionFlagBits

Defined in Vulkan.Core10.Enums.AttachmentDescriptionFlagBits

Methods

readsPrec :: Int -> ReadS AttachmentDescriptionFlagBits

readList :: ReadS [AttachmentDescriptionFlagBits]

readPrec :: ReadPrec AttachmentDescriptionFlagBits

readListPrec :: ReadPrec [AttachmentDescriptionFlagBits]

Show AttachmentDescriptionFlagBits

Defined in Vulkan.Core10.Enums.AttachmentDescriptionFlagBits

Methods

showsPrec :: Int -> AttachmentDescriptionFlagBits -> ShowS

show :: AttachmentDescriptionFlagBits -> String

showList :: [AttachmentDescriptionFlagBits] -> ShowS

Storable AttachmentDescriptionFlagBits

Defined in Vulkan.Core10.Enums.AttachmentDescriptionFlagBits

Methods

sizeOf :: AttachmentDescriptionFlagBits -> Int

alignment :: AttachmentDescriptionFlagBits -> Int

peekElemOff :: Ptr AttachmentDescriptionFlagBits -> Int -> IO AttachmentDescriptionFlagBits

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

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

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

peek :: Ptr AttachmentDescriptionFlagBits -> IO AttachmentDescriptionFlagBits

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

Bits AttachmentDescriptionFlagBits

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

Zero AttachmentDescriptionFlagBits

Defined in Vulkan.Core10.Enums.AttachmentDescriptionFlagBits

Methods

zero :: AttachmentDescriptionFlagBits

type AttachmentDescriptionFlags = AttachmentDescriptionFlagBits

newtype DependencyFlagBits

VkDependencyFlagBits - Bitmask specifying how execution and memory dependencies are formed

See Also

DependencyFlags

Constructors

DependencyFlagBits Flags

Bundled Patterns

pattern DEPENDENCY_BY_REGION_BIT :: DependencyFlagBits

DEPENDENCY_BY_REGION_BIT specifies that dependencies will be framebuffer-local.

pattern DEPENDENCY_VIEW_LOCAL_BIT :: DependencyFlagBits

DEPENDENCY_VIEW_LOCAL_BIT specifies that a subpass has more than one view.

pattern DEPENDENCY_DEVICE_GROUP_BIT :: DependencyFlagBits

DEPENDENCY_DEVICE_GROUP_BIT specifies that dependencies are non-device-local dependency.

Instances

Eq DependencyFlagBits

Defined in Vulkan.Core10.Enums.DependencyFlagBits

Methods

(==) :: DependencyFlagBits -> DependencyFlagBits -> Bool

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

Ord DependencyFlagBits

Defined in Vulkan.Core10.Enums.DependencyFlagBits

Methods

compare :: DependencyFlagBits -> DependencyFlagBits -> Ordering

(<) :: DependencyFlagBits -> DependencyFlagBits -> Bool

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

(>) :: DependencyFlagBits -> DependencyFlagBits -> Bool

(>=) :: DependencyFlagBits -> DependencyFlagBits -> Bool

max :: DependencyFlagBits -> DependencyFlagBits -> DependencyFlagBits

min :: DependencyFlagBits -> DependencyFlagBits -> DependencyFlagBits

Read DependencyFlagBits

Defined in Vulkan.Core10.Enums.DependencyFlagBits

Methods

readsPrec :: Int -> ReadS DependencyFlagBits

readList :: ReadS [DependencyFlagBits]

readPrec :: ReadPrec DependencyFlagBits

readListPrec :: ReadPrec [DependencyFlagBits]

Show DependencyFlagBits

Defined in Vulkan.Core10.Enums.DependencyFlagBits

Methods

showsPrec :: Int -> DependencyFlagBits -> ShowS

show :: DependencyFlagBits -> String

showList :: [DependencyFlagBits] -> ShowS

Storable DependencyFlagBits

Defined in Vulkan.Core10.Enums.DependencyFlagBits

Methods

sizeOf :: DependencyFlagBits -> Int

alignment :: DependencyFlagBits -> Int

peekElemOff :: Ptr DependencyFlagBits -> Int -> IO DependencyFlagBits

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

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

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

peek :: Ptr DependencyFlagBits -> IO DependencyFlagBits

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

Bits DependencyFlagBits

Defined in Vulkan.Core10.Enums.DependencyFlagBits

Methods

(.&.) :: DependencyFlagBits -> DependencyFlagBits -> DependencyFlagBits

(.|.) :: DependencyFlagBits -> DependencyFlagBits -> DependencyFlagBits

xor :: DependencyFlagBits -> DependencyFlagBits -> DependencyFlagBits

complement :: DependencyFlagBits -> DependencyFlagBits

shift :: DependencyFlagBits -> Int -> DependencyFlagBits

rotate :: DependencyFlagBits -> Int -> DependencyFlagBits

zeroBits :: DependencyFlagBits

bit :: Int -> DependencyFlagBits

setBit :: DependencyFlagBits -> Int -> DependencyFlagBits

clearBit :: DependencyFlagBits -> Int -> DependencyFlagBits

complementBit :: DependencyFlagBits -> Int -> DependencyFlagBits

testBit :: DependencyFlagBits -> Int -> Bool

bitSizeMaybe :: DependencyFlagBits -> Maybe Int

bitSize :: DependencyFlagBits -> Int

isSigned :: DependencyFlagBits -> Bool

shiftL :: DependencyFlagBits -> Int -> DependencyFlagBits

unsafeShiftL :: DependencyFlagBits -> Int -> DependencyFlagBits

shiftR :: DependencyFlagBits -> Int -> DependencyFlagBits

unsafeShiftR :: DependencyFlagBits -> Int -> DependencyFlagBits

rotateL :: DependencyFlagBits -> Int -> DependencyFlagBits

rotateR :: DependencyFlagBits -> Int -> DependencyFlagBits

popCount :: DependencyFlagBits -> Int

Zero DependencyFlagBits

Defined in Vulkan.Core10.Enums.DependencyFlagBits

Methods

zero :: DependencyFlagBits

type DependencyFlags = DependencyFlagBits

newtype SubpassDescriptionFlagBits

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 contents 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 which sources these undefined values are also undefined.

See Also

SubpassDescriptionFlags

Constructors

SubpassDescriptionFlagBits Flags

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

Eq SubpassDescriptionFlagBits

Defined in Vulkan.Core10.Enums.SubpassDescriptionFlagBits

Methods

(==) :: SubpassDescriptionFlagBits -> SubpassDescriptionFlagBits -> Bool

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

Ord SubpassDescriptionFlagBits

Defined in Vulkan.Core10.Enums.SubpassDescriptionFlagBits

Methods

compare :: SubpassDescriptionFlagBits -> SubpassDescriptionFlagBits -> Ordering

(<) :: SubpassDescriptionFlagBits -> SubpassDescriptionFlagBits -> Bool

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

(>) :: SubpassDescriptionFlagBits -> SubpassDescriptionFlagBits -> Bool

(>=) :: SubpassDescriptionFlagBits -> SubpassDescriptionFlagBits -> Bool

max :: SubpassDescriptionFlagBits -> SubpassDescriptionFlagBits -> SubpassDescriptionFlagBits

min :: SubpassDescriptionFlagBits -> SubpassDescriptionFlagBits -> SubpassDescriptionFlagBits

Read SubpassDescriptionFlagBits

Defined in Vulkan.Core10.Enums.SubpassDescriptionFlagBits

Methods

readsPrec :: Int -> ReadS SubpassDescriptionFlagBits

readList :: ReadS [SubpassDescriptionFlagBits]

readPrec :: ReadPrec SubpassDescriptionFlagBits

readListPrec :: ReadPrec [SubpassDescriptionFlagBits]

Show SubpassDescriptionFlagBits

Defined in Vulkan.Core10.Enums.SubpassDescriptionFlagBits

Methods

showsPrec :: Int -> SubpassDescriptionFlagBits -> ShowS

show :: SubpassDescriptionFlagBits -> String

showList :: [SubpassDescriptionFlagBits] -> ShowS

Storable SubpassDescriptionFlagBits

Defined in Vulkan.Core10.Enums.SubpassDescriptionFlagBits

Methods

sizeOf :: SubpassDescriptionFlagBits -> Int

alignment :: SubpassDescriptionFlagBits -> Int

peekElemOff :: Ptr SubpassDescriptionFlagBits -> Int -> IO SubpassDescriptionFlagBits

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

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

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

peek :: Ptr SubpassDescriptionFlagBits -> IO SubpassDescriptionFlagBits

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

Bits SubpassDescriptionFlagBits

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

Zero SubpassDescriptionFlagBits

Defined in Vulkan.Core10.Enums.SubpassDescriptionFlagBits

Methods

zero :: SubpassDescriptionFlagBits

type SubpassDescriptionFlags = SubpassDescriptionFlagBits

newtype FramebufferCreateFlagBits

VkFramebufferCreateFlagBits - Bitmask specifying framebuffer properties

See Also

FramebufferCreateFlags

Constructors

FramebufferCreateFlagBits Flags

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

Eq FramebufferCreateFlagBits

Defined in Vulkan.Core10.Enums.FramebufferCreateFlagBits

Methods

(==) :: FramebufferCreateFlagBits -> FramebufferCreateFlagBits -> Bool

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

Ord FramebufferCreateFlagBits

Defined in Vulkan.Core10.Enums.FramebufferCreateFlagBits

Methods

compare :: FramebufferCreateFlagBits -> FramebufferCreateFlagBits -> Ordering

(<) :: FramebufferCreateFlagBits -> FramebufferCreateFlagBits -> Bool

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

(>) :: FramebufferCreateFlagBits -> FramebufferCreateFlagBits -> Bool

(>=) :: FramebufferCreateFlagBits -> FramebufferCreateFlagBits -> Bool

max :: FramebufferCreateFlagBits -> FramebufferCreateFlagBits -> FramebufferCreateFlagBits

min :: FramebufferCreateFlagBits -> FramebufferCreateFlagBits -> FramebufferCreateFlagBits

Read FramebufferCreateFlagBits

Defined in Vulkan.Core10.Enums.FramebufferCreateFlagBits

Methods

readsPrec :: Int -> ReadS FramebufferCreateFlagBits

readList :: ReadS [FramebufferCreateFlagBits]

readPrec :: ReadPrec FramebufferCreateFlagBits

readListPrec :: ReadPrec [FramebufferCreateFlagBits]

Show FramebufferCreateFlagBits

Defined in Vulkan.Core10.Enums.FramebufferCreateFlagBits

Methods

showsPrec :: Int -> FramebufferCreateFlagBits -> ShowS

show :: FramebufferCreateFlagBits -> String

showList :: [FramebufferCreateFlagBits] -> ShowS

Storable FramebufferCreateFlagBits

Defined in Vulkan.Core10.Enums.FramebufferCreateFlagBits

Methods

sizeOf :: FramebufferCreateFlagBits -> Int

alignment :: FramebufferCreateFlagBits -> Int

peekElemOff :: Ptr FramebufferCreateFlagBits -> Int -> IO FramebufferCreateFlagBits

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

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

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

peek :: Ptr FramebufferCreateFlagBits -> IO FramebufferCreateFlagBits

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

Bits FramebufferCreateFlagBits

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

Zero FramebufferCreateFlagBits

Defined in Vulkan.Core10.Enums.FramebufferCreateFlagBits

Methods

zero :: FramebufferCreateFlagBits

type FramebufferCreateFlags = FramebufferCreateFlagBits