Top Description Inners Fields Constructors Methods
org.lwjgl.vulkan

public Class VkExternalMemoryAcquireUnmodifiedEXT

extends Struct<VkExternalMemoryAcquireUnmodifiedEXT>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable
Imports
javax.annotation.*, java.nio.*, org.lwjgl.*, org.lwjgl.system.*

Structure specifying that external memory has remained unmodified since releasing ownership.
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
Valid Usage (Implicit)

Layout


struct VkExternalMemoryAcquireUnmodifiedEXT {
    VkStructureType sType;
    void const * pNext;
    VkBool32 acquireUnmodifiedMemory;
}

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class

Field Summary

Modifier and TypeField and Description
public static final int
ACQUIREUNMODIFIEDMEMORY

The struct member offsets.

public static final int
ALIGNOF

The struct alignment in bytes.

public static final int
PNEXT

The struct member offsets.

public static final int
SIZEOF

The struct size in bytes.

public static final int
STYPE

The struct member offsets.

Inherited from org.lwjgl.system.Struct:
containerDEFAULT_ALIGN_ASDEFAULT_PACK_ALIGNMENT

Constructor Summary

AccessConstructor and Description
protected
public
VkExternalMemoryAcquireUnmodifiedEXT(ByteBuffer container)

Creates a VkExternalMemoryAcquireUnmodifiedEXT instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and TypeMethod and Description
public boolean
acquireUnmodifiedMemory()

specifies, if TRUE, that no range of VkDeviceMemory bound 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’s srcQueueFamilyIndex.

public VkExternalMemoryAcquireUnmodifiedEXT
acquireUnmodifiedMemory(boolean value)

Sets the specified value to the acquireUnmodifiedMemory field.

public static VkExternalMemoryAcquireUnmodifiedEXT
calloc()

Returns a new VkExternalMemoryAcquireUnmodifiedEXT instance allocated with memCalloc.

public static VkExternalMemoryAcquireUnmodifiedEXT.Buffer
calloc(int
the buffer capacity
capacity
)

Returns a new VkExternalMemoryAcquireUnmodifiedEXT.Buffer instance allocated with memCalloc.

public static VkExternalMemoryAcquireUnmodifiedEXT
calloc(MemoryStack
the stack from which to allocate
stack
)

Returns a new VkExternalMemoryAcquireUnmodifiedEXT instance allocated on the specified MemoryStack and initializes all its bits to zero.

public static VkExternalMemoryAcquireUnmodifiedEXT.Buffer
calloc(int
the buffer capacity
capacity
,
MemoryStack
the stack from which to allocate
stack
)

Returns a new VkExternalMemoryAcquireUnmodifiedEXT.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.

protected VkExternalMemoryAcquireUnmodifiedEXT
create(long
the struct memory address
address
,
ByteBuffer
an optional container buffer, to be referenced strongly by the struct instance.
container
)

Implements abstract org.lwjgl.system.Struct.create.

Similar to the constructor, but returns the exact type of the Struct subclass.
public static VkExternalMemoryAcquireUnmodifiedEXT
create()

Returns a new VkExternalMemoryAcquireUnmodifiedEXT instance allocated with BufferUtils.

public static VkExternalMemoryAcquireUnmodifiedEXT
create(long address)

Returns a new VkExternalMemoryAcquireUnmodifiedEXT instance for the specified memory address.

public static VkExternalMemoryAcquireUnmodifiedEXT.Buffer
create(int
the buffer capacity
capacity
)

Returns a new VkExternalMemoryAcquireUnmodifiedEXT.Buffer instance allocated with BufferUtils.

public static VkExternalMemoryAcquireUnmodifiedEXT.Buffer
create(long
the memory address
address
,
int
the buffer capacity
capacity
)

Create a VkExternalMemoryAcquireUnmodifiedEXT.Buffer instance at the specified memory.

public static VkExternalMemoryAcquireUnmodifiedEXT
createSafe(long address)

Like create, but returns null if address is NULL.

public static VkExternalMemoryAcquireUnmodifiedEXT.Buffer
createSafe(long address, int capacity)

Like create, but returns null if address is NULL.

public static VkExternalMemoryAcquireUnmodifiedEXT
malloc()

Returns a new VkExternalMemoryAcquireUnmodifiedEXT instance allocated with memAlloc.

public static VkExternalMemoryAcquireUnmodifiedEXT.Buffer
malloc(int
the buffer capacity
capacity
)

Returns a new VkExternalMemoryAcquireUnmodifiedEXT.Buffer instance allocated with memAlloc.

public static VkExternalMemoryAcquireUnmodifiedEXT
malloc(MemoryStack
the stack from which to allocate
stack
)

Returns a new VkExternalMemoryAcquireUnmodifiedEXT instance allocated on the specified MemoryStack.

public static VkExternalMemoryAcquireUnmodifiedEXT.Buffer
malloc(int
the buffer capacity
capacity
,
MemoryStack
the stack from which to allocate
stack
)

Returns a new VkExternalMemoryAcquireUnmodifiedEXT.Buffer instance allocated on the specified MemoryStack.

public static int
nacquireUnmodifiedMemory(long struct)

Unsafe version of acquireUnmodifiedMemory.

public static void
nacquireUnmodifiedMemory(long struct, int value)

Unsafe version of acquireUnmodifiedMemory.

public static long
npNext(long struct)

Unsafe version of pNext.

public static void
npNext(long struct, long value)

Unsafe version of pNext.

public static int
nsType(long struct)

Unsafe version of sType.

public static void
nsType(long struct, int value)

Unsafe version of sType.

public long
pNext()

NULL or a pointer to a structure extending this structure.

public VkExternalMemoryAcquireUnmodifiedEXT
pNext(long value)

Sets the specified value to the pNext field.

public VkExternalMemoryAcquireUnmodifiedEXT
set(int sType, long pNext, boolean acquireUnmodifiedMemory)

Initializes this struct with the specified values.

public VkExternalMemoryAcquireUnmodifiedEXT

Returns:

this struct
set
(VkExternalMemoryAcquireUnmodifiedEXT
the source struct
src
)

Copies the specified struct data to this struct.

public int
sizeof()

Implements abstract org.lwjgl.system.Struct.sizeof.

Returns sizeof(struct).
public int
sType()

a VkStructureType value identifying this structure.

public VkExternalMemoryAcquireUnmodifiedEXT
sType(int value)

Sets the specified value to the sType field.

public VkExternalMemoryAcquireUnmodifiedEXT
Inherited from org.lwjgl.system.Struct:
__array__array__array__checkContainer__checkMalloc__create__getContainer__getContainer__member__member__member__padding__padding__struct__struct__union__unionclearfreeisNullvalidate

Field Detail

ACQUIREUNMODIFIEDMEMORYback to summary
public static final int ACQUIREUNMODIFIEDMEMORY

The struct member offsets.

ALIGNOFback to summary
public static final int ALIGNOF

The struct alignment in bytes.

PNEXTback to summary
public static final int PNEXT

The struct member offsets.

SIZEOFback to summary
public static final int SIZEOF

The struct size in bytes.

STYPEback to summary
public static final int STYPE

The struct member offsets.

Constructor Detail

VkExternalMemoryAcquireUnmodifiedEXTback to summary
protected VkExternalMemoryAcquireUnmodifiedEXT(long address, ByteBuffer container)
VkExternalMemoryAcquireUnmodifiedEXTback to summary
public VkExternalMemoryAcquireUnmodifiedEXT(ByteBuffer container)

Creates a VkExternalMemoryAcquireUnmodifiedEXT instance at the current position of the specified ByteBuffer container. 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 Detail

acquireUnmodifiedMemoryback to summary
public boolean acquireUnmodifiedMemory()

specifies, if TRUE, that no range of VkDeviceMemory bound 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’s srcQueueFamilyIndex. If FALSE, it specifies nothing.

Annotations
@NativeType:VkBool32
acquireUnmodifiedMemoryback to summary
public VkExternalMemoryAcquireUnmodifiedEXT acquireUnmodifiedMemory(boolean value)

Sets the specified value to the acquireUnmodifiedMemory field.

callocback to summary
public static VkExternalMemoryAcquireUnmodifiedEXT calloc()

Returns a new VkExternalMemoryAcquireUnmodifiedEXT instance allocated with memCalloc. The instance must be explicitly freed.

callocback to summary
public static VkExternalMemoryAcquireUnmodifiedEXT.Buffer calloc(int capacity)

Returns a new VkExternalMemoryAcquireUnmodifiedEXT.Buffer instance allocated with memCalloc. The instance must be explicitly freed.

Parameters
capacity:int

the buffer capacity

callocback to summary
public static VkExternalMemoryAcquireUnmodifiedEXT calloc(MemoryStack stack)

Returns a new VkExternalMemoryAcquireUnmodifiedEXT instance allocated on the specified MemoryStack and initializes all its bits to zero.

Parameters
stack:MemoryStack

the stack from which to allocate

callocback to summary
public static VkExternalMemoryAcquireUnmodifiedEXT.Buffer calloc(int capacity, MemoryStack stack)

Returns a new VkExternalMemoryAcquireUnmodifiedEXT.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

createback to summary
protected VkExternalMemoryAcquireUnmodifiedEXT create(long address, ByteBuffer container)

Implements abstract org.lwjgl.system.Struct.create.

Doc from org.lwjgl.system.Struct.create.

Similar to the constructor, but returns the exact type of the Struct subclass.

Effectively, every Struct instance is a factory for more instances of the same type. This is used by StructBuffer.

Parameters
address:long

the struct memory address

container:ByteBuffer

an optional container buffer, to be referenced strongly by the struct instance.

Annotations
@Override
createback to summary
public static VkExternalMemoryAcquireUnmodifiedEXT create()

Returns a new VkExternalMemoryAcquireUnmodifiedEXT instance allocated with BufferUtils.

createback to summary
public static VkExternalMemoryAcquireUnmodifiedEXT create(long address)

Returns a new VkExternalMemoryAcquireUnmodifiedEXT instance for the specified memory address.

createback to summary
public static VkExternalMemoryAcquireUnmodifiedEXT.Buffer create(int capacity)

Returns a new VkExternalMemoryAcquireUnmodifiedEXT.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

createback to summary
public static VkExternalMemoryAcquireUnmodifiedEXT.Buffer create(long address, int capacity)

Create a VkExternalMemoryAcquireUnmodifiedEXT.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static VkExternalMemoryAcquireUnmodifiedEXT createSafe(long address)

Like create, but returns null if address is NULL.

Annotations
@Nullable
createSafeback to summary
public static VkExternalMemoryAcquireUnmodifiedEXT.Buffer createSafe(long address, int capacity)

Like create, but returns null if address is NULL.

Annotations
@Nullable
mallocback to summary
public static VkExternalMemoryAcquireUnmodifiedEXT malloc()

Returns a new VkExternalMemoryAcquireUnmodifiedEXT instance allocated with memAlloc. The instance must be explicitly freed.

mallocback to summary
public static VkExternalMemoryAcquireUnmodifiedEXT.Buffer malloc(int capacity)

Returns a new VkExternalMemoryAcquireUnmodifiedEXT.Buffer instance allocated with memAlloc. The instance must be explicitly freed.

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static VkExternalMemoryAcquireUnmodifiedEXT malloc(MemoryStack stack)

Returns a new VkExternalMemoryAcquireUnmodifiedEXT instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

mallocback to summary
public static VkExternalMemoryAcquireUnmodifiedEXT.Buffer malloc(int capacity, MemoryStack stack)

Returns a new VkExternalMemoryAcquireUnmodifiedEXT.Buffer instance allocated on the specified MemoryStack.

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

nacquireUnmodifiedMemoryback to summary
public static int nacquireUnmodifiedMemory(long struct)

Unsafe version of acquireUnmodifiedMemory.

nacquireUnmodifiedMemoryback to summary
public static void nacquireUnmodifiedMemory(long struct, int value)

Unsafe version of acquireUnmodifiedMemory.

npNextback to summary
public static long npNext(long struct)

Unsafe version of pNext.

npNextback to summary
public static void npNext(long struct, long value)

Unsafe version of pNext.

nsTypeback to summary
public static int nsType(long struct)

Unsafe version of sType.

nsTypeback to summary
public static void nsType(long struct, int value)

Unsafe version of sType.

pNextback to summary
public long pNext()

NULL or a pointer to a structure extending this structure.

Annotations
@NativeType:void const *
pNextback to summary
public VkExternalMemoryAcquireUnmodifiedEXT pNext(long value)

Sets the specified value to the pNext field.

setback to summary
public VkExternalMemoryAcquireUnmodifiedEXT set(int sType, long pNext, boolean acquireUnmodifiedMemory)

Initializes this struct with the specified values.

setback to summary
public VkExternalMemoryAcquireUnmodifiedEXT set(VkExternalMemoryAcquireUnmodifiedEXT src)

Copies the specified struct data to this struct.

Parameters
src:VkExternalMemoryAcquireUnmodifiedEXT

the source struct

Returns:VkExternalMemoryAcquireUnmodifiedEXT

this struct

sizeofback to summary
public int sizeof()

Implements abstract org.lwjgl.system.Struct.sizeof.

Doc from org.lwjgl.system.Struct.sizeof.

Returns sizeof(struct).

Annotations
@Override
sTypeback to summary
public int sType()

a VkStructureType value identifying this structure.

Annotations
@NativeType:VkStructureType
sTypeback to summary
public VkExternalMemoryAcquireUnmodifiedEXT sType(int value)

Sets the specified value to the sType field.

sType$Defaultback to summary
public VkExternalMemoryAcquireUnmodifiedEXT sType$Default()

Sets the STRUCTURE_TYPE_EXTERNAL_MEMORY_ACQUIRE_UNMODIFIED_EXT value to the sType field.

org.lwjgl.vulkan back to summary

public Class VkExternalMemoryAcquireUnmodifiedEXT.Buffer

extends StructBuffer<VkExternalMemoryAcquireUnmodifiedEXT, VkExternalMemoryAcquireUnmodifiedEXT.Buffer>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable

An array of VkExternalMemoryAcquireUnmodifiedEXT structs.

Field Summary

Modifier and TypeField and Description
private static final VkExternalMemoryAcquireUnmodifiedEXT

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new VkExternalMemoryAcquireUnmodifiedEXT.Buffer instance backed by the specified container.

public
Buffer(long address, int cap)

pack-priv
Buffer(long address, ByteBuffer container, int mark, int pos, int lim, int cap)

Method Summary

Modifier and TypeMethod and Description
public boolean
public VkExternalMemoryAcquireUnmodifiedEXT.Buffer
protected VkExternalMemoryAcquireUnmodifiedEXT
public long

Returns:

the value of the VkExternalMemoryAcquireUnmodifiedEXT#pNext field.
pNext
()

public VkExternalMemoryAcquireUnmodifiedEXT.Buffer
pNext(long value)

Sets the specified value to the VkExternalMemoryAcquireUnmodifiedEXT#pNext field.

protected VkExternalMemoryAcquireUnmodifiedEXT.Buffer
public int

Returns:

the value of the VkExternalMemoryAcquireUnmodifiedEXT#sType field.
sType
()

public VkExternalMemoryAcquireUnmodifiedEXT.Buffer
sType(int value)

Sets the specified value to the VkExternalMemoryAcquireUnmodifiedEXT#sType field.

public VkExternalMemoryAcquireUnmodifiedEXT.Buffer
Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final VkExternalMemoryAcquireUnmodifiedEXT ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

Creates a new VkExternalMemoryAcquireUnmodifiedEXT.Buffer instance backed by the specified container.

Changes to the container's content will be visible to the struct buffer instance and vice versa. The two buffers' position, limit, and mark values will be independent. The new buffer's position will be zero, its capacity and its limit will be the number of bytes remaining in this buffer divided by VkExternalMemoryAcquireUnmodifiedEXT#SIZEOF, and its mark will be undefined.

The created buffer instance holds a strong reference to the container object.

Bufferback to summary
public Buffer(long address, int cap)
Bufferback to summary
pack-priv Buffer(long address, ByteBuffer container, int mark, int pos, int lim, int cap)

Method Detail

acquireUnmodifiedMemoryback to summary
public boolean acquireUnmodifiedMemory()
Returns:boolean

the value of the VkExternalMemoryAcquireUnmodifiedEXT#acquireUnmodifiedMemory field.

Annotations
@NativeType:VkBool32
acquireUnmodifiedMemoryback to summary
public VkExternalMemoryAcquireUnmodifiedEXT.Buffer acquireUnmodifiedMemory(boolean value)

Sets the specified value to the VkExternalMemoryAcquireUnmodifiedEXT#acquireUnmodifiedMemory field.

getElementFactoryback to summary
protected VkExternalMemoryAcquireUnmodifiedEXT getElementFactory()

Implements abstract org.lwjgl.system.StructBuffer.getElementFactory.

Annotations
@Override
pNextback to summary
public long pNext()
Returns:long

the value of the VkExternalMemoryAcquireUnmodifiedEXT#pNext field.

Annotations
@NativeType:void const *
pNextback to summary
public VkExternalMemoryAcquireUnmodifiedEXT.Buffer pNext(long value)

Sets the specified value to the VkExternalMemoryAcquireUnmodifiedEXT#pNext field.

selfback to summary
protected VkExternalMemoryAcquireUnmodifiedEXT.Buffer self()

Implements abstract org.lwjgl.system.CustomBuffer.self.

Annotations
@Override
sTypeback to summary
public int sType()
Returns:int

the value of the VkExternalMemoryAcquireUnmodifiedEXT#sType field.

Annotations
@NativeType:VkStructureType
sTypeback to summary
public VkExternalMemoryAcquireUnmodifiedEXT.Buffer sType(int value)

Sets the specified value to the VkExternalMemoryAcquireUnmodifiedEXT#sType field.

sType$Defaultback to summary
public VkExternalMemoryAcquireUnmodifiedEXT.Buffer sType$Default()

Sets the STRUCTURE_TYPE_EXTERNAL_MEMORY_ACQUIRE_UNMODIFIED_EXT value to the VkExternalMemoryAcquireUnmodifiedEXT#sType field.