Class VkMemoryMapInfoKHR

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkMemoryMapInfo>

org.lwjgl.vulkan.VkMemoryMapInfo

org.lwjgl.vulkan.VkMemoryMapInfoKHR

All Implemented Interfaces:

AutoCloseable, NativeResource, Pointer

public class VkMemoryMapInfoKHR
extends VkMemoryMapInfo

struct VkMemoryMapInfoKHR {
    VkStructureType sType;
    void const * pNext;
    VkMemoryMapFlags flags;
    VkDeviceMemory memory;
    VkDeviceSize offset;
    VkDeviceSize size;
}

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	VkMemoryMapInfoKHR.Buffer	An array of VkMemoryMapInfoKHR structs.

Nested classes/interfaces inherited from class Struct

Struct.StructValidation

Nested classes/interfaces inherited from interface Pointer

Pointer.Default

Field Summary

Fields inherited from class VkMemoryMapInfo

ALIGNOF, FLAGS, MEMORY, OFFSET, PNEXT, SIZE, SIZEOF, STYPE

Fields inherited from interface Pointer

BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE

Constructor Summary

Constructors

Constructor	Description
VkMemoryMapInfoKHR(ByteBuffer container)	Creates a VkMemoryMapInfoKHR instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and Type	Method	Description
static VkMemoryMapInfoKHR	calloc()	Returns a new VkMemoryMapInfoKHR instance allocated with memCalloc.
static VkMemoryMapInfoKHR.Buffer	calloc(int capacity)	Returns a new VkMemoryMapInfoKHR.Buffer instance allocated with memCalloc.
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.
static VkMemoryMapInfoKHR	calloc(MemoryStack stack)	Returns a new VkMemoryMapInfoKHR instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkMemoryMapInfoKHR	create()	Returns a new VkMemoryMapInfoKHR instance allocated with BufferUtils.
static VkMemoryMapInfoKHR.Buffer	create(int capacity)	Returns a new VkMemoryMapInfoKHR.Buffer instance allocated with BufferUtils.
static VkMemoryMapInfoKHR	create(long address)	Returns a new VkMemoryMapInfoKHR instance for the specified memory address.
static VkMemoryMapInfoKHR.Buffer	create(long address, int capacity)	Create a VkMemoryMapInfoKHR.Buffer instance at the specified memory.
static @Nullable VkMemoryMapInfoKHR	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable VkMemoryMapInfoKHR.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
VkMemoryMapInfoKHR	flags(int value)	Sets the specified value to the flags field.
static VkMemoryMapInfoKHR	malloc()	Returns a new VkMemoryMapInfoKHR instance allocated with memAlloc.
static VkMemoryMapInfoKHR.Buffer	malloc(int capacity)	Returns a new VkMemoryMapInfoKHR.Buffer instance allocated with memAlloc.
static VkMemoryMapInfoKHR.Buffer	malloc(int capacity, MemoryStack stack)	Returns a new VkMemoryMapInfoKHR.Buffer instance allocated on the specified MemoryStack.
static VkMemoryMapInfoKHR	malloc(MemoryStack stack)	Returns a new VkMemoryMapInfoKHR instance allocated on the specified MemoryStack.
VkMemoryMapInfoKHR	memory(long value)	Sets the specified value to the memory field.
VkMemoryMapInfoKHR	offset(long value)	Sets the specified value to the offset field.
VkMemoryMapInfoKHR	pNext(long value)	Sets the specified value to the pNext field.
VkMemoryMapInfoKHR	set(int sType, long pNext, int flags, long memory, long offset, long size)	Initializes this struct with the specified values.
VkMemoryMapInfoKHR	set(VkMemoryMapInfoKHR src)	Copies the specified struct data to this struct.
VkMemoryMapInfoKHR	size(long value)	Sets the specified value to the size field.
VkMemoryMapInfoKHR	sType(int value)	Sets the specified value to the sType field.
VkMemoryMapInfoKHR	sType$Default()	Sets the STRUCTURE_TYPE_MEMORY_MAP_INFO value to the sType field.

Methods inherited from class VkMemoryMapInfo

flags, memory, nflags, nflags, nmemory, nmemory, noffset, noffset, npNext, npNext, nsize, nsize, nsType, nsType, offset, pNext, pNext, set, size, sizeof, sType

Methods inherited from class Struct

clear, free, isNull, validate, validate

Methods inherited from class Pointer.Default

address, equals, hashCode, toString

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface NativeResource

close, free

Constructor Details

VkMemoryMapInfoKHR

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 Details

sType

public VkMemoryMapInfoKHR sType(@NativeType("VkStructureType")
 int value)

Sets the specified value to the sType field.

Overrides:

sType in class VkMemoryMapInfo

sType$Default

public VkMemoryMapInfoKHR sType$Default()

Sets the STRUCTURE_TYPE_MEMORY_MAP_INFO value to the sType field.

Overrides:

sType$Default in class VkMemoryMapInfo

pNext

public VkMemoryMapInfoKHR pNext(@NativeType("void const *")
 long value)

Sets the specified value to the pNext field.

Overrides:

pNext in class VkMemoryMapInfo

flags

public VkMemoryMapInfoKHR flags(@NativeType("VkMemoryMapFlags")
 int value)

Sets the specified value to the flags field.

Overrides:

flags in class VkMemoryMapInfo

memory

public VkMemoryMapInfoKHR memory(@NativeType("VkDeviceMemory")
 long value)

Sets the specified value to the memory field.

Overrides:

memory in class VkMemoryMapInfo

offset

public VkMemoryMapInfoKHR offset(@NativeType("VkDeviceSize")
 long value)

Sets the specified value to the offset field.

Overrides:

offset in class VkMemoryMapInfo

size

public VkMemoryMapInfoKHR size(@NativeType("VkDeviceSize")
 long value)

Sets the specified value to the size field.

Overrides:

size in class VkMemoryMapInfo

set

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

Initializes this struct with the specified values.

Overrides:

set in class VkMemoryMapInfo

set

public VkMemoryMapInfoKHR set(VkMemoryMapInfoKHR src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static VkMemoryMapInfoKHR malloc()

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

calloc

public static VkMemoryMapInfoKHR calloc()

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

create

public static VkMemoryMapInfoKHR create()

Returns a new VkMemoryMapInfoKHR instance allocated with BufferUtils.

create

public static VkMemoryMapInfoKHR create(long address)

Returns a new VkMemoryMapInfoKHR instance for the specified memory address.

createSafe

public static @Nullable VkMemoryMapInfoKHR createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VkMemoryMapInfoKHR.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static VkMemoryMapInfoKHR.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static VkMemoryMapInfoKHR.Buffer create(int capacity)

Returns a new VkMemoryMapInfoKHR.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a VkMemoryMapInfoKHR.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

public static VkMemoryMapInfoKHR malloc(MemoryStack stack)

Returns a new VkMemoryMapInfoKHR instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

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 - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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 - the buffer capacity

stack - the stack from which to allocate