Package org.lwjgl.vulkan
Class VkMappedMemoryRange
- All Implemented Interfaces:
AutoCloseable
,NativeResource
,Pointer
Structure specifying a mapped memory range.
Valid Usage
memory
must be currently host mapped- If
size
is not equal toWHOLE_SIZE
,offset
andsize
must specify a range contained within the currently mapped range ofmemory
- If
size
is equal toWHOLE_SIZE
,offset
must be within the currently mapped range ofmemory
offset
must be a multiple ofVkPhysicalDeviceLimits
::nonCoherentAtomSize
- If
size
is equal toWHOLE_SIZE
, the end of the current mapping ofmemory
must either be a multiple ofVkPhysicalDeviceLimits
::nonCoherentAtomSize
bytes from the beginning of the memory object, or be equal to the end of the memory object - If
size
is not equal toWHOLE_SIZE
,size
must either be a multiple ofVkPhysicalDeviceLimits
::nonCoherentAtomSize
, oroffset
plussize
must equal the size ofmemory
Valid Usage (Implicit)
sType
must beSTRUCTURE_TYPE_MAPPED_MEMORY_RANGE
pNext
must beNULL
memory
must be a validVkDeviceMemory
handle
See Also
FlushMappedMemoryRanges
, InvalidateMappedMemoryRanges
Layout
struct VkMappedMemoryRange {
VkStructureType sType()
;
void const * pNext()
;
VkDeviceMemory memory()
;
VkDeviceSize offset()
;
VkDeviceSize size()
;
}
-
Nested Class Summary
Nested classes/interfaces inherited from class org.lwjgl.system.Struct
Struct.StructValidation
Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer
Pointer.Default
-
Field Summary
Modifier and TypeFieldDescriptionstatic final int
The struct alignment in bytes.static final int
The struct member offsets.static final int
The struct member offsets.static final int
The struct member offsets.static final int
The struct member offsets.static final int
The struct size in bytes.static final int
The struct member offsets.Fields inherited from interface org.lwjgl.system.Pointer
BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE
-
Constructor Summary
ConstructorDescriptionVkMappedMemoryRange
(ByteBuffer container) Creates aVkMappedMemoryRange
instance at the current position of the specifiedByteBuffer
container. -
Method Summary
Modifier and TypeMethodDescriptionstatic VkMappedMemoryRange
calloc()
Returns a newVkMappedMemoryRange
instance allocated withmemCalloc
.static VkMappedMemoryRange.Buffer
calloc
(int capacity) Returns a newVkMappedMemoryRange.Buffer
instance allocated withmemCalloc
.static VkMappedMemoryRange.Buffer
calloc
(int capacity, MemoryStack stack) Returns a newVkMappedMemoryRange.Buffer
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.static VkMappedMemoryRange
calloc
(MemoryStack stack) Returns a newVkMappedMemoryRange
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.static VkMappedMemoryRange
Deprecated.static VkMappedMemoryRange.Buffer
callocStack
(int capacity) Deprecated.static VkMappedMemoryRange.Buffer
callocStack
(int capacity, MemoryStack stack) Deprecated.static VkMappedMemoryRange
callocStack
(MemoryStack stack) Deprecated.static VkMappedMemoryRange
create()
Returns a newVkMappedMemoryRange
instance allocated withBufferUtils
.static VkMappedMemoryRange.Buffer
create
(int capacity) Returns a newVkMappedMemoryRange.Buffer
instance allocated withBufferUtils
.static VkMappedMemoryRange
create
(long address) Returns a newVkMappedMemoryRange
instance for the specified memory address.static VkMappedMemoryRange.Buffer
create
(long address, int capacity) Create aVkMappedMemoryRange.Buffer
instance at the specified memory.static VkMappedMemoryRange
createSafe
(long address) static VkMappedMemoryRange.Buffer
createSafe
(long address, int capacity) static VkMappedMemoryRange
malloc()
Returns a newVkMappedMemoryRange
instance allocated withmemAlloc
.static VkMappedMemoryRange.Buffer
malloc
(int capacity) Returns a newVkMappedMemoryRange.Buffer
instance allocated withmemAlloc
.static VkMappedMemoryRange.Buffer
malloc
(int capacity, MemoryStack stack) Returns a newVkMappedMemoryRange.Buffer
instance allocated on the specifiedMemoryStack
.static VkMappedMemoryRange
malloc
(MemoryStack stack) Returns a newVkMappedMemoryRange
instance allocated on the specifiedMemoryStack
.static VkMappedMemoryRange
Deprecated.static VkMappedMemoryRange.Buffer
mallocStack
(int capacity) Deprecated.static VkMappedMemoryRange.Buffer
mallocStack
(int capacity, MemoryStack stack) Deprecated.static VkMappedMemoryRange
mallocStack
(MemoryStack stack) Deprecated.long
memory()
the memory object to which this range belongs.memory
(long value) Sets the specified value to thememory()
field.static long
nmemory
(long struct) Unsafe version ofmemory()
.static void
nmemory
(long struct, long value) Unsafe version ofmemory
.static long
noffset
(long struct) Unsafe version ofoffset()
.static void
noffset
(long struct, long value) Unsafe version ofoffset
.static long
npNext
(long struct) Unsafe version ofpNext()
.static void
npNext
(long struct, long value) Unsafe version ofpNext
.static long
nsize
(long struct) Unsafe version ofsize()
.static void
nsize
(long struct, long value) Unsafe version ofsize
.static int
nsType
(long struct) Unsafe version ofsType()
.static void
nsType
(long struct, int value) Unsafe version ofsType
.long
offset()
the zero-based byte offset from the beginning of the memory object.offset
(long value) Sets the specified value to theoffset()
field.long
pNext()
NULL
or a pointer to a structure extending this structure.pNext
(long value) Sets the specified value to thepNext()
field.set
(int sType, long pNext, long memory, long offset, long size) Initializes this struct with the specified values.set
(VkMappedMemoryRange src) Copies the specified struct data to this struct.long
size()
either the size of range, orWHOLE_SIZE
to affect the range fromoffset
to the end of the current mapping of the allocation.size
(long value) Sets the specified value to thesize()
field.int
sizeof()
Returnssizeof(struct)
.int
sType()
aVkStructureType
value identifying this structure.sType
(int value) Sets the specified value to thesType()
field.Sets theSTRUCTURE_TYPE_MAPPED_MEMORY_RANGE
value to thesType()
field.Methods inherited from class org.lwjgl.system.Pointer.Default
address, equals, hashCode, toString
Methods 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. -
MEMORY
public static final int MEMORYThe struct member offsets. -
OFFSET
public static final int OFFSETThe struct member offsets. -
SIZE
public static final int SIZEThe struct member offsets.
-
-
Constructor Details
-
VkMappedMemoryRange
Creates aVkMappedMemoryRange
instance at the current position of the specifiedByteBuffer
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 Details
-
sizeof
public int sizeof()Description copied from class:Struct
Returnssizeof(struct)
.- Specified by:
sizeof
in classStruct<VkMappedMemoryRange>
-
sType
public int sType()aVkStructureType
value identifying this structure. -
pNext
public long pNext()NULL
or a pointer to a structure extending this structure. -
memory
public long memory()the memory object to which this range belongs. -
offset
public long offset()the zero-based byte offset from the beginning of the memory object. -
size
public long size()either the size of range, orWHOLE_SIZE
to affect the range fromoffset
to the end of the current mapping of the allocation. -
sType
Sets the specified value to thesType()
field. -
sType$Default
Sets theSTRUCTURE_TYPE_MAPPED_MEMORY_RANGE
value to thesType()
field. -
pNext
Sets the specified value to thepNext()
field. -
memory
Sets the specified value to thememory()
field. -
offset
Sets the specified value to theoffset()
field. -
size
Sets the specified value to thesize()
field. -
set
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 newVkMappedMemoryRange
instance allocated withmemAlloc
. The instance must be explicitly freed. -
calloc
Returns a newVkMappedMemoryRange
instance allocated withmemCalloc
. The instance must be explicitly freed. -
create
Returns a newVkMappedMemoryRange
instance allocated withBufferUtils
. -
create
Returns a newVkMappedMemoryRange
instance for the specified memory address. -
createSafe
-
malloc
Returns a newVkMappedMemoryRange.Buffer
instance allocated withmemAlloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
calloc
Returns a newVkMappedMemoryRange.Buffer
instance allocated withmemCalloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
create
Returns a newVkMappedMemoryRange.Buffer
instance allocated withBufferUtils
.- Parameters:
capacity
- the buffer capacity
-
create
Create aVkMappedMemoryRange.Buffer
instance at the specified memory.- Parameters:
address
- the memory addresscapacity
- the buffer capacity
-
createSafe
-
mallocStack
Deprecated.Deprecated for removal in 3.4.0. Usemalloc(MemoryStack)
instead. -
callocStack
Deprecated.Deprecated for removal in 3.4.0. Usecalloc(MemoryStack)
instead. -
mallocStack
Deprecated.Deprecated for removal in 3.4.0. Usemalloc(MemoryStack)
instead. -
callocStack
Deprecated.Deprecated for removal in 3.4.0. Usecalloc(MemoryStack)
instead. -
mallocStack
Deprecated.Deprecated for removal in 3.4.0. Usemalloc(int, MemoryStack)
instead. -
callocStack
Deprecated.Deprecated for removal in 3.4.0. Usecalloc(int, MemoryStack)
instead. -
mallocStack
Deprecated.Deprecated for removal in 3.4.0. Usemalloc(int, MemoryStack)
instead. -
callocStack
Deprecated.Deprecated for removal in 3.4.0. Usecalloc(int, MemoryStack)
instead. -
malloc
Returns a newVkMappedMemoryRange
instance allocated on the specifiedMemoryStack
.- Parameters:
stack
- the stack from which to allocate
-
calloc
Returns a newVkMappedMemoryRange
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.- Parameters:
stack
- the stack from which to allocate
-
malloc
Returns a newVkMappedMemoryRange.Buffer
instance allocated on the specifiedMemoryStack
.- Parameters:
capacity
- the buffer capacitystack
- the stack from which to allocate
-
calloc
Returns a newVkMappedMemoryRange.Buffer
instance allocated on the specifiedMemoryStack
and 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()
. -
nmemory
public static long nmemory(long struct) Unsafe version ofmemory()
. -
noffset
public static long noffset(long struct) Unsafe version ofoffset()
. -
nsize
public static long nsize(long struct) Unsafe version ofsize()
. -
nsType
public static void nsType(long struct, int value) Unsafe version ofsType
. -
npNext
public static void npNext(long struct, long value) Unsafe version ofpNext
. -
nmemory
public static void nmemory(long struct, long value) Unsafe version ofmemory
. -
noffset
public static void noffset(long struct, long value) Unsafe version ofoffset
. -
nsize
public static void nsize(long struct, long value) Unsafe version ofsize
.
-