VKGETRENDERAREAGRANU(3)

NAME
vkGetRenderAreaGranularity - Returns the granularity for optimal render area.

C SPECIFICATION

To query the render area granularity, call:

    void vkGetRenderAreaGranularity(
        VkDevice                                    device,
        VkRenderPass                                renderPass,
        VkExtent2D*                                 pGranularity);

PARAMETERS

    • device is the logical device that owns the render pass.

    • renderPass is a handle to a render pass.

    • pGranularity points to a VkExtent2D structure in which the granularity is returned.

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 VkExtent2D (the horizontal granularity).

    • the offset.y member in renderArea is a multiple of the height of the returned VkExtent2D (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 VkRenderPassBeginInfo.

    • 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 VkRenderPassBeginInfo.

Subpass dependencies are not affected by the render area, and apply to the entire image subresources attached to the framebuffer. Similarly, pipeline barriers are valid even if their effect extends outside the render area.

VALID USAGE

    • device must be a valid VkDevice handle

    • renderPass must be a valid VkRenderPass handle

    • pGranularity must be a pointer to a VkExtent2D structure

    • renderPass must have been created, allocated, or retrieved from device

SEE ALSO

VkDevice, VkExtent2D, VkRenderPass

DOCUMENT NOTES

For more information, see the Vulkan Specification at URL

https://www.khronos.org/registry/vulkan/specs/1.0/xhtml/vkspec.html#vkGetRenderAreaGranularity

This page is extracted from the Vulkan Specification. Fixes and changes should be made to the Specification,not directly.

COPYRIGHT

Copyright (c) 2014-2016 Khronos Group. This work is licensed under a Creative Commons Attribution 4.0 International License.

AUTHOR

Khronos Group
    Author.