VKMAPPEDMEMORYRANGE(3)

NAME
VkMappedMemoryRange - Structure specifying a mapped memory range

C SPECIFICATION

The VkMappedMemoryRange structure is defined as:

    typedef struct VkMappedMemoryRange {
        VkStructureType    sType;
        const void*        pNext;
        VkDeviceMemory     memory;
        VkDeviceSize       offset;
        VkDeviceSize       size;
    } VkMappedMemoryRange;

MEMBERS

    • sType is the type of this structure.

    • pNext is NULL or a pointer to an extension-specific structure.

    • memory is the memory object to which this range belongs.

    • offset is the zero-based byte offset from the beginning of the memory object.

    • size is either the size of range, or VK_WHOLE_SIZE to affect the range from offset to the end of the current mapping of the allocation.

DESCRIPTION

VALID USAGE

    • sType must be VK_STRUCTURE_TYPE_MAPPED_MEMORY_RANGE

    • pNext must be NULL

    • memory must be a valid VkDeviceMemory handle

    • memory must currently be mapped

    • If size is not equal to VK_WHOLE_SIZE, offset and size must specify a range contained within the currently mapped range of memory

    • If size is equal to VK_WHOLE_SIZE, offset must be within the currently mapped range of memory

    • offset must be a multiple of VkPhysicalDeviceLimits::nonCoherentAtomSize

    • If size is not equal to VK_WHOLE_SIZE, size must be a multiple of VkPhysicalDeviceLimits::nonCoherentAtomSize

SEE ALSO

VkDeviceMemory, VkDeviceSize, VkStructureType, vkFlushMappedMemoryRanges, vkInvalidateMappedMemoryRanges

DOCUMENT NOTES

For more information, see the Vulkan Specification at URL

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

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.