Top Description Inners Fields Constructors Methods
org.lwjgl.vulkan

public Class VkMemoryMapInfoKHR

extends Struct<VkMemoryMapInfoKHR>
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 containing parameters of a memory map operation.
Valid Usage
Valid Usage (Implicit)
Host Synchronization
See Also

MapMemory2KHR

Layout


struct VkMemoryMapInfoKHR {
    VkStructureType sType;
    void const * pNext;
    VkMemoryMapFlags flags;
    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
FLAGS

The struct member offsets.

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

public
VkMemoryMapInfoKHR(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public static VkMemoryMapInfoKHR
calloc()

Returns a new VkMemoryMapInfoKHR instance allocated with memCalloc.

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

Returns a new VkMemoryMapInfoKHR.Buffer instance allocated with memCalloc.

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

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

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

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

protected VkMemoryMapInfoKHR
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 VkMemoryMapInfoKHR
create()

Returns a new VkMemoryMapInfoKHR instance allocated with BufferUtils.

public static VkMemoryMapInfoKHR
create(long address)

Returns a new VkMemoryMapInfoKHR instance for the specified memory address.

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

Returns a new VkMemoryMapInfoKHR.Buffer instance allocated with BufferUtils.

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

Create a VkMemoryMapInfoKHR.Buffer instance at the specified memory.

public static VkMemoryMapInfoKHR
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public int
flags()

reserved for future use.

public VkMemoryMapInfoKHR
flags(int value)

Sets the specified value to the flags field.

public static VkMemoryMapInfoKHR
malloc()

Returns a new VkMemoryMapInfoKHR instance allocated with memAlloc.

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

Returns a new VkMemoryMapInfoKHR.Buffer instance allocated with memAlloc.

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

Returns a new VkMemoryMapInfoKHR instance allocated on the specified MemoryStack.

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

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

public long
memory()

the VkDeviceMemory object to be mapped.

public VkMemoryMapInfoKHR
memory(long value)

Sets the specified value to the memory field.

public static int
nflags(long struct)

Unsafe version of flags.

public static void
nflags(long struct, int value)

Unsafe version of flags.

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()

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

public VkMemoryMapInfoKHR
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 VkMemoryMapInfoKHR
pNext(long value)

Sets the specified value to the pNext field.

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

Initializes this struct with the specified values.

public VkMemoryMapInfoKHR

Returns:

this struct
set
(VkMemoryMapInfoKHR
the source struct
src
)

Copies the specified struct data to this struct.

public long
size()

the size of the memory range to map, or WHOLE_SIZE to map from offset to the end of the allocation.

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

Sets the specified value to the sType field.

public VkMemoryMapInfoKHR
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.

FLAGSback to summary
public static final int FLAGS

The struct member offsets.

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

VkMemoryMapInfoKHRback to summary
protected VkMemoryMapInfoKHR(long address, ByteBuffer container)
VkMemoryMapInfoKHRback to summary
public VkMemoryMapInfoKHR(ByteBuffer container)

Creates a VkMemoryMapInfoKHR 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 VkMemoryMapInfoKHR calloc()

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

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

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static VkMemoryMapInfoKHR calloc(MemoryStack stack)

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

Returns a new VkMemoryMapInfoKHR.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 VkMemoryMapInfoKHR 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 VkMemoryMapInfoKHR create()

Returns a new VkMemoryMapInfoKHR instance allocated with BufferUtils.

createback to summary
public static VkMemoryMapInfoKHR create(long address)

Returns a new VkMemoryMapInfoKHR instance for the specified memory address.

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

Returns a new VkMemoryMapInfoKHR.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a VkMemoryMapInfoKHR.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static VkMemoryMapInfoKHR createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

Annotations
@Nullable
flagsback to summary
public int flags()

reserved for future use.

Annotations
@NativeType:VkMemoryMapFlags
flagsback to summary
public VkMemoryMapInfoKHR flags(int value)

Sets the specified value to the flags field.

mallocback to summary
public static VkMemoryMapInfoKHR malloc()

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

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

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static VkMemoryMapInfoKHR malloc(MemoryStack stack)

Returns a new VkMemoryMapInfoKHR instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

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

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

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

memoryback to summary
public long memory()

the VkDeviceMemory object to be mapped.

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

Sets the specified value to the memory field.

nflagsback to summary
public static int nflags(long struct)

Unsafe version of flags.

nflagsback to summary
public static void nflags(long struct, int value)

Unsafe version of flags.

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()

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

Annotations
@NativeType:VkDeviceSize
offsetback to summary
public VkMemoryMapInfoKHR 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 VkMemoryMapInfoKHR pNext(long value)

Sets the specified value to the pNext field.

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

Initializes this struct with the specified values.

setback to summary
public VkMemoryMapInfoKHR set(VkMemoryMapInfoKHR src)

Copies the specified struct data to this struct.

Parameters
src:VkMemoryMapInfoKHR

the source struct

Returns:VkMemoryMapInfoKHR

this struct

sizeback to summary
public long size()

the size of the memory range to map, or WHOLE_SIZE to map from offset to the end of the allocation.

Annotations
@NativeType:VkDeviceSize
sizeback to summary
public VkMemoryMapInfoKHR 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 VkMemoryMapInfoKHR sType(int value)

Sets the specified value to the sType field.

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

Sets the STRUCTURE_TYPE_MEMORY_MAP_INFO_KHR value to the sType field.

org.lwjgl.vulkan back to summary

public Class VkMemoryMapInfoKHR.Buffer

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

An array of VkMemoryMapInfoKHR structs.

Field Summary

Modifier and TypeField and Description
private static final VkMemoryMapInfoKHR

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new VkMemoryMapInfoKHR.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 int

Returns:

the value of the VkMemoryMapInfoKHR#flags field.
flags
()

public VkMemoryMapInfoKHR.Buffer
flags(int value)

Sets the specified value to the VkMemoryMapInfoKHR#flags field.

protected VkMemoryMapInfoKHR
public long

Returns:

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

public VkMemoryMapInfoKHR.Buffer
memory(long value)

Sets the specified value to the VkMemoryMapInfoKHR#memory field.

public long

Returns:

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

public VkMemoryMapInfoKHR.Buffer
offset(long value)

Sets the specified value to the VkMemoryMapInfoKHR#offset field.

public long

Returns:

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

public VkMemoryMapInfoKHR.Buffer
pNext(long value)

Sets the specified value to the VkMemoryMapInfoKHR#pNext field.

protected VkMemoryMapInfoKHR.Buffer
public long

Returns:

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

public VkMemoryMapInfoKHR.Buffer
size(long value)

Sets the specified value to the VkMemoryMapInfoKHR#size field.

public int

Returns:

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

public VkMemoryMapInfoKHR.Buffer
sType(int value)

Sets the specified value to the VkMemoryMapInfoKHR#sType field.

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

Field Detail

ELEMENT_FACTORYback to summary
private static final VkMemoryMapInfoKHR ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

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

flagsback to summary
public int flags()
Returns:int

the value of the VkMemoryMapInfoKHR#flags field.

Annotations
@NativeType:VkMemoryMapFlags
flagsback to summary
public VkMemoryMapInfoKHR.Buffer flags(int value)

Sets the specified value to the VkMemoryMapInfoKHR#flags field.

getElementFactoryback to summary
protected VkMemoryMapInfoKHR getElementFactory()

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

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

the value of the VkMemoryMapInfoKHR#memory field.

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

Sets the specified value to the VkMemoryMapInfoKHR#memory field.

offsetback to summary
public long offset()
Returns:long

the value of the VkMemoryMapInfoKHR#offset field.

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

Sets the specified value to the VkMemoryMapInfoKHR#offset field.

pNextback to summary
public long pNext()
Returns:long

the value of the VkMemoryMapInfoKHR#pNext field.

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

Sets the specified value to the VkMemoryMapInfoKHR#pNext field.

selfback to summary
protected VkMemoryMapInfoKHR.Buffer self()

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

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

the value of the VkMemoryMapInfoKHR#size field.

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

Sets the specified value to the VkMemoryMapInfoKHR#size field.

sTypeback to summary
public int sType()
Returns:int

the value of the VkMemoryMapInfoKHR#sType field.

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

Sets the specified value to the VkMemoryMapInfoKHR#sType field.

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

Sets the STRUCTURE_TYPE_MEMORY_MAP_INFO_KHR value to the VkMemoryMapInfoKHR#sType field.