Class VkExternalMemoryAcquireUnmodifiedEXT
- All Implemented Interfaces:
AutoCloseable,org.lwjgl.system.NativeResource,org.lwjgl.system.Pointer
Description
If the application releases ownership of the subresource range to one of the special queue families reserved for external memory ownership transfers with a memory barrier structure, and later re-acquires ownership from the same queue family with a memory barrier structure, and if no range of VkDeviceMemory bound to the resource was modified at any time between the release operation and the acquire operation, then the application should add a VkExternalMemoryAcquireUnmodifiedEXT structure to the pNext chain of the acquire operation's memory barrier structure because this may reduce the performance penalty.
This struct is ignored if acquireUnmodifiedMemory is FALSE. In particular, FALSE does not specify that memory was modified.
This struct is ignored if the memory barrier’s srcQueueFamilyIndex is not a special queue family reserved for external memory ownership transfers.
Note
The method by which the application determines whether memory was modified between the release operation and acquire operation is outside the scope of Vulkan.
For any Vulkan operation that accesses a resource, the application must not assume the implementation accesses the resource’s memory as read-only, even for apparently read-only operations such as transfer commands and shader reads.
The validity of VkExternalMemoryAcquireUnmodifiedEXT::acquireUnmodifiedMemory is independent of memory ranges outside the ranges of VkDeviceMemory bound to the resource. In particular, it is independent of any implementation-private memory associated with the resource.
Valid Usage
- If
acquireUnmodifiedMemoryisTRUE, and the memory barrier’ssrcQueueFamilyIndexis a special queue family reserved for external memory ownership transfers (as described in Queue Family Ownership Transfer), then each range ofVkDeviceMemorybound to the resource must have remained unmodified during all time since the resource’s most recent release of ownership to the queue family
Valid Usage (Implicit)
sTypemust beSTRUCTURE_TYPE_EXTERNAL_MEMORY_ACQUIRE_UNMODIFIED_EXT
Layout
struct VkExternalMemoryAcquireUnmodifiedEXT {
VkStructureType sType();
void const * pNext();
VkBool32 acquireUnmodifiedMemory();
}-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic classAn array ofVkExternalMemoryAcquireUnmodifiedEXTstructs.Nested classes/interfaces inherited from class org.lwjgl.system.Struct
org.lwjgl.system.Struct.StructValidationNested classes/interfaces inherited from interface org.lwjgl.system.Pointer
org.lwjgl.system.Pointer.Default -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final intThe struct member offsets.static final intThe struct alignment in bytes.static final intThe struct member offsets.static final intThe struct size in bytes.static final intThe struct member offsets.Fields inherited from interface org.lwjgl.system.Pointer
BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE -
Constructor Summary
ConstructorsConstructorDescriptionVkExternalMemoryAcquireUnmodifiedEXT(ByteBuffer container) Creates aVkExternalMemoryAcquireUnmodifiedEXTinstance at the current position of the specifiedByteBuffercontainer. -
Method Summary
Modifier and TypeMethodDescriptionbooleanspecifies, ifTRUE, that no range ofVkDeviceMemorybound to the resource of the memory barrier’s subresource range was modified at any time since the resource’s most recent release of ownership to the queue family specified by the memory barrier’ssrcQueueFamilyIndex.acquireUnmodifiedMemory(boolean value) Sets the specified value to theacquireUnmodifiedMemory()field.calloc()Returns a newVkExternalMemoryAcquireUnmodifiedEXTinstance allocated withmemCalloc.calloc(int capacity) Returns a newVkExternalMemoryAcquireUnmodifiedEXT.Bufferinstance allocated withmemCalloc.calloc(int capacity, org.lwjgl.system.MemoryStack stack) Returns a newVkExternalMemoryAcquireUnmodifiedEXT.Bufferinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.calloc(org.lwjgl.system.MemoryStack stack) Returns a newVkExternalMemoryAcquireUnmodifiedEXTinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.create()Returns a newVkExternalMemoryAcquireUnmodifiedEXTinstance allocated withBufferUtils.create(int capacity) Returns a newVkExternalMemoryAcquireUnmodifiedEXT.Bufferinstance allocated withBufferUtils.create(long address) Returns a newVkExternalMemoryAcquireUnmodifiedEXTinstance for the specified memory address.create(long address, int capacity) Create aVkExternalMemoryAcquireUnmodifiedEXT.Bufferinstance at the specified memory.static @Nullable VkExternalMemoryAcquireUnmodifiedEXTcreateSafe(long address) static @Nullable VkExternalMemoryAcquireUnmodifiedEXT.BuffercreateSafe(long address, int capacity) malloc()Returns a newVkExternalMemoryAcquireUnmodifiedEXTinstance allocated withmemAlloc.malloc(int capacity) Returns a newVkExternalMemoryAcquireUnmodifiedEXT.Bufferinstance allocated withmemAlloc.malloc(int capacity, org.lwjgl.system.MemoryStack stack) Returns a newVkExternalMemoryAcquireUnmodifiedEXT.Bufferinstance allocated on the specifiedMemoryStack.malloc(org.lwjgl.system.MemoryStack stack) Returns a newVkExternalMemoryAcquireUnmodifiedEXTinstance allocated on the specifiedMemoryStack.static intnacquireUnmodifiedMemory(long struct) Unsafe version ofacquireUnmodifiedMemory().static voidnacquireUnmodifiedMemory(long struct, int value) Unsafe version ofacquireUnmodifiedMemory.static longnpNext(long struct) Unsafe version ofpNext().static voidnpNext(long struct, long value) Unsafe version ofpNext.static intnsType(long struct) Unsafe version ofsType().static voidnsType(long struct, int value) Unsafe version ofsType.longpNext()NULLor a pointer to a structure extending this structure.pNext(long value) Sets the specified value to thepNext()field.set(int sType, long pNext, boolean acquireUnmodifiedMemory) Initializes this struct with the specified values.Copies the specified struct data to this struct.intsizeof()intsType()aVkStructureTypevalue identifying this structure.sType(int value) Sets the specified value to thesType()field.Sets theSTRUCTURE_TYPE_EXTERNAL_MEMORY_ACQUIRE_UNMODIFIED_EXTvalue to thesType()field.Methods inherited from class org.lwjgl.system.Struct
clear, free, isNull, validate, validateMethods inherited from class org.lwjgl.system.Pointer.Default
address, equals, hashCode, toStringMethods inherited from interface org.lwjgl.system.NativeResource
close, free
-
Field Details
-
SIZEOF
public static final int SIZEOFThe struct size in bytes. -
ALIGNOF
public static final int ALIGNOFThe struct alignment in bytes. -
STYPE
public static final int STYPEThe struct member offsets. -
PNEXT
public static final int PNEXTThe struct member offsets. -
ACQUIREUNMODIFIEDMEMORY
public static final int ACQUIREUNMODIFIEDMEMORYThe struct member offsets.
-
-
Constructor Details
-
VkExternalMemoryAcquireUnmodifiedEXT
Creates aVkExternalMemoryAcquireUnmodifiedEXTinstance at the current position of the specifiedByteBuffercontainer. Changes to the buffer's content will be visible to the struct instance and vice versa.The created instance holds a strong reference to the container object.
-
-
Method Details
-
sizeof
public int sizeof()- Specified by:
sizeofin classorg.lwjgl.system.Struct<VkExternalMemoryAcquireUnmodifiedEXT>
-
sType
public int sType()aVkStructureTypevalue identifying this structure. -
pNext
public long pNext()NULLor a pointer to a structure extending this structure. -
acquireUnmodifiedMemory
public boolean acquireUnmodifiedMemory()specifies, ifTRUE, that no range ofVkDeviceMemorybound to the resource of the memory barrier’s subresource range was modified at any time since the resource’s most recent release of ownership to the queue family specified by the memory barrier’ssrcQueueFamilyIndex. IfFALSE, it specifies nothing. -
sType
Sets the specified value to thesType()field. -
sType$Default
Sets theSTRUCTURE_TYPE_EXTERNAL_MEMORY_ACQUIRE_UNMODIFIED_EXTvalue to thesType()field. -
pNext
Sets the specified value to thepNext()field. -
acquireUnmodifiedMemory
Sets the specified value to theacquireUnmodifiedMemory()field. -
set
public VkExternalMemoryAcquireUnmodifiedEXT set(int sType, long pNext, boolean acquireUnmodifiedMemory) Initializes this struct with the specified values. -
set
Copies the specified struct data to this struct.- Parameters:
src- the source struct- Returns:
- this struct
-
malloc
Returns a newVkExternalMemoryAcquireUnmodifiedEXTinstance allocated withmemAlloc. The instance must be explicitly freed. -
calloc
Returns a newVkExternalMemoryAcquireUnmodifiedEXTinstance allocated withmemCalloc. The instance must be explicitly freed. -
create
Returns a newVkExternalMemoryAcquireUnmodifiedEXTinstance allocated withBufferUtils. -
create
Returns a newVkExternalMemoryAcquireUnmodifiedEXTinstance for the specified memory address. -
createSafe
-
malloc
Returns a newVkExternalMemoryAcquireUnmodifiedEXT.Bufferinstance allocated withmemAlloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
calloc
Returns a newVkExternalMemoryAcquireUnmodifiedEXT.Bufferinstance allocated withmemCalloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
create
Returns a newVkExternalMemoryAcquireUnmodifiedEXT.Bufferinstance allocated withBufferUtils.- Parameters:
capacity- the buffer capacity
-
create
Create aVkExternalMemoryAcquireUnmodifiedEXT.Bufferinstance at the specified memory.- Parameters:
address- the memory addresscapacity- the buffer capacity
-
createSafe
public static @Nullable VkExternalMemoryAcquireUnmodifiedEXT.Buffer createSafe(long address, int capacity) -
malloc
Returns a newVkExternalMemoryAcquireUnmodifiedEXTinstance allocated on the specifiedMemoryStack.- Parameters:
stack- the stack from which to allocate
-
calloc
Returns a newVkExternalMemoryAcquireUnmodifiedEXTinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.- Parameters:
stack- the stack from which to allocate
-
malloc
public static VkExternalMemoryAcquireUnmodifiedEXT.Buffer malloc(int capacity, org.lwjgl.system.MemoryStack stack) Returns a newVkExternalMemoryAcquireUnmodifiedEXT.Bufferinstance allocated on the specifiedMemoryStack.- Parameters:
capacity- the buffer capacitystack- the stack from which to allocate
-
calloc
public static VkExternalMemoryAcquireUnmodifiedEXT.Buffer calloc(int capacity, org.lwjgl.system.MemoryStack stack) Returns a newVkExternalMemoryAcquireUnmodifiedEXT.Bufferinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.- Parameters:
capacity- the buffer capacitystack- the stack from which to allocate
-
nsType
public static int nsType(long struct) Unsafe version ofsType(). -
npNext
public static long npNext(long struct) Unsafe version ofpNext(). -
nacquireUnmodifiedMemory
public static int nacquireUnmodifiedMemory(long struct) Unsafe version ofacquireUnmodifiedMemory(). -
nsType
public static void nsType(long struct, int value) Unsafe version ofsType. -
npNext
public static void npNext(long struct, long value) Unsafe version ofpNext. -
nacquireUnmodifiedMemory
public static void nacquireUnmodifiedMemory(long struct, int value) Unsafe version ofacquireUnmodifiedMemory.
-