Top Description Inners Fields Constructors Methods
org.lwjgl.vulkan

public Class VkMappedMemoryRange

extends Struct<VkMappedMemoryRange>
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 a mapped memory range.
Valid Usage
Valid Usage (Implicit)
See Also

FlushMappedMemoryRanges, InvalidateMappedMemoryRanges

Layout


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

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class

Field Summary

Modifier and TypeField and Description
public static final int
ALIGNOF

The struct alignment in bytes.

public static final int
MEMORY

The struct member offsets.

public static final int
OFFSET

The struct member offsets.

public static final int
PNEXT

The struct member offsets.

public static final int
SIZE

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
VkMappedMemoryRange(long address, ByteBuffer container)

public
VkMappedMemoryRange(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public static VkMappedMemoryRange
calloc()

Returns a new VkMappedMemoryRange instance allocated with memCalloc.

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

Returns a new VkMappedMemoryRange.Buffer instance allocated with memCalloc.

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

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

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

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

public static VkMappedMemoryRange
callocStack()

Deprecated
Deprecated for removal in 3.4.0.
public static VkMappedMemoryRange
callocStack(MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
public static VkMappedMemoryRange.Buffer
callocStack(int capacity)

Deprecated
Deprecated for removal in 3.4.0.
public static VkMappedMemoryRange.Buffer
callocStack(int capacity, MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
protected VkMappedMemoryRange
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 VkMappedMemoryRange
create()

Returns a new VkMappedMemoryRange instance allocated with BufferUtils.

public static VkMappedMemoryRange
create(long address)

Returns a new VkMappedMemoryRange instance for the specified memory address.

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

Returns a new VkMappedMemoryRange.Buffer instance allocated with BufferUtils.

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

Create a VkMappedMemoryRange.Buffer instance at the specified memory.

public static VkMappedMemoryRange
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public static VkMappedMemoryRange
malloc()

Returns a new VkMappedMemoryRange instance allocated with memAlloc.

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

Returns a new VkMappedMemoryRange.Buffer instance allocated with memAlloc.

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

Returns a new VkMappedMemoryRange instance allocated on the specified MemoryStack.

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

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

public static VkMappedMemoryRange
mallocStack()

Deprecated
Deprecated for removal in 3.4.0.
public static VkMappedMemoryRange
mallocStack(MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
public static VkMappedMemoryRange.Buffer
mallocStack(int capacity)

Deprecated
Deprecated for removal in 3.4.0.
public static VkMappedMemoryRange.Buffer
mallocStack(int capacity, MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
public long
memory()

the memory object to which this range belongs.

public VkMappedMemoryRange
memory(long value)

Sets the specified value to the memory field.

public static long
nmemory(long struct)

Unsafe version of memory.

public static void
nmemory(long struct, long value)

Unsafe version of memory.

public static long
noffset(long struct)

Unsafe version of offset.

public static void
noffset(long struct, long value)

Unsafe version of offset.

public static long
npNext(long struct)

Unsafe version of pNext.

public static void
npNext(long struct, long value)

Unsafe version of pNext.

public static long
nsize(long struct)

Unsafe version of size.

public static void
nsize(long struct, long value)

Unsafe version of size.

public static int
nsType(long struct)

Unsafe version of sType.

public static void
nsType(long struct, int value)

Unsafe version of sType.

public long
offset()

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

public VkMappedMemoryRange
offset(long value)

Sets the specified value to the offset field.

public long
pNext()

NULL or a pointer to a structure extending this structure.

public VkMappedMemoryRange
pNext(long value)

Sets the specified value to the pNext field.

public VkMappedMemoryRange
set(int sType, long pNext, long memory, long offset, long size)

Initializes this struct with the specified values.

public VkMappedMemoryRange

Returns:

this struct
set
(VkMappedMemoryRange
the source struct
src
)

Copies the specified struct data to this struct.

public long
size()

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

public VkMappedMemoryRange
size(long value)

Sets the specified value to the size field.

public int
sizeof()

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

Returns sizeof(struct).
public int
sType()

a VkStructureType value identifying this structure.

public VkMappedMemoryRange
sType(int value)

Sets the specified value to the sType field.

public VkMappedMemoryRange
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

ALIGNOFback to summary
public static final int ALIGNOF

The struct alignment in bytes.

MEMORYback to summary
public static final int MEMORY

The struct member offsets.

OFFSETback to summary
public static final int OFFSET

The struct member offsets.

PNEXTback to summary
public static final int PNEXT

The struct member offsets.

SIZEback to summary
public static final int SIZE

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

VkMappedMemoryRangeback to summary
protected VkMappedMemoryRange(long address, ByteBuffer container)
VkMappedMemoryRangeback to summary
public VkMappedMemoryRange(ByteBuffer container)

Creates a VkMappedMemoryRange 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

callocback to summary
public static VkMappedMemoryRange calloc()

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

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

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static VkMappedMemoryRange calloc(MemoryStack stack)

Returns a new VkMappedMemoryRange 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 VkMappedMemoryRange.Buffer calloc(int capacity, MemoryStack stack)

Returns a new VkMappedMemoryRange.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

callocStackback to summary
public static VkMappedMemoryRange callocStack()

Deprecated

Deprecated for removal in 3.4.0. Use calloc(MemoryStack) instead.

Annotations
@Deprecated
callocStackback to summary
public static VkMappedMemoryRange callocStack(MemoryStack stack)

Deprecated

Deprecated for removal in 3.4.0. Use calloc(MemoryStack) instead.

Annotations
@Deprecated
callocStackback to summary
public static VkMappedMemoryRange.Buffer callocStack(int capacity)

Deprecated

Deprecated for removal in 3.4.0. Use calloc(int, MemoryStack) instead.

Annotations
@Deprecated
callocStackback to summary
public static VkMappedMemoryRange.Buffer callocStack(int capacity, MemoryStack stack)

Deprecated

Deprecated for removal in 3.4.0. Use calloc(int, MemoryStack) instead.

Annotations
@Deprecated
createback to summary
protected VkMappedMemoryRange 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 VkMappedMemoryRange create()

Returns a new VkMappedMemoryRange instance allocated with BufferUtils.

createback to summary
public static VkMappedMemoryRange create(long address)

Returns a new VkMappedMemoryRange instance for the specified memory address.

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

Returns a new VkMappedMemoryRange.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a VkMappedMemoryRange.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static VkMappedMemoryRange createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

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

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

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

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static VkMappedMemoryRange malloc(MemoryStack stack)

Returns a new VkMappedMemoryRange instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

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

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

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

mallocStackback to summary
public static VkMappedMemoryRange mallocStack()

Deprecated

Deprecated for removal in 3.4.0. Use malloc(MemoryStack) instead.

Annotations
@Deprecated
mallocStackback to summary
public static VkMappedMemoryRange mallocStack(MemoryStack stack)

Deprecated

Deprecated for removal in 3.4.0. Use malloc(MemoryStack) instead.

Annotations
@Deprecated
mallocStackback to summary
public static VkMappedMemoryRange.Buffer mallocStack(int capacity)

Deprecated

Deprecated for removal in 3.4.0. Use malloc(int, MemoryStack) instead.

Annotations
@Deprecated
mallocStackback to summary
public static VkMappedMemoryRange.Buffer mallocStack(int capacity, MemoryStack stack)

Deprecated

Deprecated for removal in 3.4.0. Use malloc(int, MemoryStack) instead.

Annotations
@Deprecated
memoryback to summary
public long memory()

the memory object to which this range belongs.

Annotations
@NativeType:VkDeviceMemory
memoryback to summary
public VkMappedMemoryRange memory(long value)

Sets the specified value to the memory field.

nmemoryback to summary
public static long nmemory(long struct)

Unsafe version of memory.

nmemoryback to summary
public static void nmemory(long struct, long value)

Unsafe version of memory.

noffsetback to summary
public static long noffset(long struct)

Unsafe version of offset.

noffsetback to summary
public static void noffset(long struct, long value)

Unsafe version of offset.

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.

nsizeback to summary
public static long nsize(long struct)

Unsafe version of size.

nsizeback to summary
public static void nsize(long struct, long value)

Unsafe version of size.

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.

offsetback to summary
public long offset()

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

Annotations
@NativeType:VkDeviceSize
offsetback to summary
public VkMappedMemoryRange offset(long value)

Sets the specified value to the offset field.

pNextback to summary
public long pNext()

NULL or a pointer to a structure extending this structure.

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

Sets the specified value to the pNext field.

setback to summary
public VkMappedMemoryRange set(int sType, long pNext, long memory, long offset, long size)

Initializes this struct with the specified values.

setback to summary
public VkMappedMemoryRange set(VkMappedMemoryRange src)

Copies the specified struct data to this struct.

Parameters
src:VkMappedMemoryRange

the source struct

Returns:VkMappedMemoryRange

this struct

sizeback to summary
public long size()

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

Annotations
@NativeType:VkDeviceSize
sizeback to summary
public VkMappedMemoryRange size(long value)

Sets the specified value to the size field.

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 VkMappedMemoryRange sType(int value)

Sets the specified value to the sType field.

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

Sets the STRUCTURE_TYPE_MAPPED_MEMORY_RANGE value to the sType field.

org.lwjgl.vulkan back to summary

public Class VkMappedMemoryRange.Buffer

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

An array of VkMappedMemoryRange structs.

Field Summary

Modifier and TypeField and Description
private static final VkMappedMemoryRange

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new VkMappedMemoryRange.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
protected VkMappedMemoryRange
public long

Returns:

the value of the VkMappedMemoryRange#memory field.
memory
()

public VkMappedMemoryRange.Buffer
memory(long value)

Sets the specified value to the VkMappedMemoryRange#memory field.

public long

Returns:

the value of the VkMappedMemoryRange#offset field.
offset
()

public VkMappedMemoryRange.Buffer
offset(long value)

Sets the specified value to the VkMappedMemoryRange#offset field.

public long

Returns:

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

public VkMappedMemoryRange.Buffer
pNext(long value)

Sets the specified value to the VkMappedMemoryRange#pNext field.

protected VkMappedMemoryRange.Buffer
public long

Returns:

the value of the VkMappedMemoryRange#size field.
size
()

public VkMappedMemoryRange.Buffer
size(long value)

Sets the specified value to the VkMappedMemoryRange#size field.

public int

Returns:

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

public VkMappedMemoryRange.Buffer
sType(int value)

Sets the specified value to the VkMappedMemoryRange#sType field.

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

Field Detail

ELEMENT_FACTORYback to summary
private static final VkMappedMemoryRange ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

Creates a new VkMappedMemoryRange.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 VkMappedMemoryRange#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

getElementFactoryback to summary
protected VkMappedMemoryRange getElementFactory()

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

Annotations
@Override
memoryback to summary
public long memory()
Returns:long

the value of the VkMappedMemoryRange#memory field.

Annotations
@NativeType:VkDeviceMemory
memoryback to summary
public VkMappedMemoryRange.Buffer memory(long value)

Sets the specified value to the VkMappedMemoryRange#memory field.

offsetback to summary
public long offset()
Returns:long

the value of the VkMappedMemoryRange#offset field.

Annotations
@NativeType:VkDeviceSize
offsetback to summary
public VkMappedMemoryRange.Buffer offset(long value)

Sets the specified value to the VkMappedMemoryRange#offset field.

pNextback to summary
public long pNext()
Returns:long

the value of the VkMappedMemoryRange#pNext field.

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

Sets the specified value to the VkMappedMemoryRange#pNext field.

selfback to summary
protected VkMappedMemoryRange.Buffer self()

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

Annotations
@Override
sizeback to summary
public long size()
Returns:long

the value of the VkMappedMemoryRange#size field.

Annotations
@NativeType:VkDeviceSize
sizeback to summary
public VkMappedMemoryRange.Buffer size(long value)

Sets the specified value to the VkMappedMemoryRange#size field.

sTypeback to summary
public int sType()
Returns:int

the value of the VkMappedMemoryRange#sType field.

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

Sets the specified value to the VkMappedMemoryRange#sType field.

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

Sets the STRUCTURE_TYPE_MAPPED_MEMORY_RANGE value to the VkMappedMemoryRange#sType field.