Package org.lwjgl.vulkan

Class VkDeviceMemoryOverallocationCreateInfoAMD

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkDeviceMemoryOverallocationCreateInfoAMD>

org.lwjgl.vulkan.VkDeviceMemoryOverallocationCreateInfoAMD

All Implemented Interfaces:

AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer

public class VkDeviceMemoryOverallocationCreateInfoAMD
extends org.lwjgl.system.Struct<VkDeviceMemoryOverallocationCreateInfoAMD>
implements org.lwjgl.system.NativeResource

Specify memory overallocation behavior for a Vulkan device.

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_DEVICE_MEMORY_OVERALLOCATION_CREATE_INFO_AMD
• overallocationBehavior must be a valid VkMemoryOverallocationBehaviorAMD value

Layout

 struct VkDeviceMemoryOverallocationCreateInfoAMD {
     VkStructureType sType();
     void const * pNext();
     VkMemoryOverallocationBehaviorAMD overallocationBehavior();
 }

Nested Class Summary

Nested Classes

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

Nested classes/interfaces inherited from class org.lwjgl.system.Struct

org.lwjgl.system.Struct.StructValidation

Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer

org.lwjgl.system.Pointer.Default

Field Summary

Fields

Modifier and Type	Field	Description
static final int	ALIGNOF	The struct alignment in bytes.
static final int	OVERALLOCATIONBEHAVIOR	The struct member offsets.
static final int	PNEXT	The struct member offsets.
static final int	SIZEOF	The struct size in bytes.
static final int	STYPE	The struct member offsets.

Fields inherited from interface org.lwjgl.system.Pointer

BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static VkDeviceMemoryOverallocationCreateInfoAMD	calloc()	Returns a new VkDeviceMemoryOverallocationCreateInfoAMD instance allocated with memCalloc.
static VkDeviceMemoryOverallocationCreateInfoAMD.Buffer	calloc(int capacity)	Returns a new VkDeviceMemoryOverallocationCreateInfoAMD.Buffer instance allocated with memCalloc.
static VkDeviceMemoryOverallocationCreateInfoAMD.Buffer	calloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkDeviceMemoryOverallocationCreateInfoAMD.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkDeviceMemoryOverallocationCreateInfoAMD	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkDeviceMemoryOverallocationCreateInfoAMD instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkDeviceMemoryOverallocationCreateInfoAMD	callocStack()	Deprecated.
static VkDeviceMemoryOverallocationCreateInfoAMD.Buffer	callocStack(int capacity)	Deprecated.
static VkDeviceMemoryOverallocationCreateInfoAMD.Buffer	callocStack(int capacity, org.lwjgl.system.MemoryStack stack)	Deprecated.
static VkDeviceMemoryOverallocationCreateInfoAMD	callocStack(org.lwjgl.system.MemoryStack stack)	Deprecated.
static VkDeviceMemoryOverallocationCreateInfoAMD	create()	Returns a new VkDeviceMemoryOverallocationCreateInfoAMD instance allocated with BufferUtils.
static VkDeviceMemoryOverallocationCreateInfoAMD.Buffer	create(int capacity)	Returns a new VkDeviceMemoryOverallocationCreateInfoAMD.Buffer instance allocated with BufferUtils.
static VkDeviceMemoryOverallocationCreateInfoAMD	create(long address)	Returns a new VkDeviceMemoryOverallocationCreateInfoAMD instance for the specified memory address.
static VkDeviceMemoryOverallocationCreateInfoAMD.Buffer	create(long address, int capacity)	Create a VkDeviceMemoryOverallocationCreateInfoAMD.Buffer instance at the specified memory.
static @Nullable VkDeviceMemoryOverallocationCreateInfoAMD	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable VkDeviceMemoryOverallocationCreateInfoAMD.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
static VkDeviceMemoryOverallocationCreateInfoAMD	malloc()	Returns a new VkDeviceMemoryOverallocationCreateInfoAMD instance allocated with memAlloc.
static VkDeviceMemoryOverallocationCreateInfoAMD.Buffer	malloc(int capacity)	Returns a new VkDeviceMemoryOverallocationCreateInfoAMD.Buffer instance allocated with memAlloc.
static VkDeviceMemoryOverallocationCreateInfoAMD.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkDeviceMemoryOverallocationCreateInfoAMD.Buffer instance allocated on the specified MemoryStack.
static VkDeviceMemoryOverallocationCreateInfoAMD	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkDeviceMemoryOverallocationCreateInfoAMD instance allocated on the specified MemoryStack.
static VkDeviceMemoryOverallocationCreateInfoAMD	mallocStack()	Deprecated.
static VkDeviceMemoryOverallocationCreateInfoAMD.Buffer	mallocStack(int capacity)	Deprecated.
static VkDeviceMemoryOverallocationCreateInfoAMD.Buffer	mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)	Deprecated.
static VkDeviceMemoryOverallocationCreateInfoAMD	mallocStack(org.lwjgl.system.MemoryStack stack)	Deprecated.
static int	noverallocationBehavior(long struct)	Unsafe version of overallocationBehavior().
static void	noverallocationBehavior(long struct, int value)	Unsafe version of overallocationBehavior.
static long	npNext(long struct)	Unsafe version of pNext().
static void	npNext(long struct, long value)	Unsafe version of pNext.
static int	nsType(long struct)	Unsafe version of sType().
static void	nsType(long struct, int value)	Unsafe version of sType.
int	overallocationBehavior()	the desired overallocation behavior.
VkDeviceMemoryOverallocationCreateInfoAMD	overallocationBehavior(int value)	Sets the specified value to the overallocationBehavior() field.
long	pNext()	NULL or a pointer to a structure extending this structure.
VkDeviceMemoryOverallocationCreateInfoAMD	pNext(long value)	Sets the specified value to the pNext() field.
VkDeviceMemoryOverallocationCreateInfoAMD	set(int sType, long pNext, int overallocationBehavior)	Initializes this struct with the specified values.
VkDeviceMemoryOverallocationCreateInfoAMD	set(VkDeviceMemoryOverallocationCreateInfoAMD src)	Copies the specified struct data to this struct.
int	sizeof()
int	sType()	a VkStructureType value identifying this structure.
VkDeviceMemoryOverallocationCreateInfoAMD	sType(int value)	Sets the specified value to the sType() field.
VkDeviceMemoryOverallocationCreateInfoAMD	sType$Default()	Sets the STRUCTURE_TYPE_DEVICE_MEMORY_OVERALLOCATION_CREATE_INFO_AMD value to the sType() field.

Methods inherited from class org.lwjgl.system.Struct

clear, free, isNull, validate, validate

Methods inherited from class org.lwjgl.system.Pointer.Default

address, equals, hashCode, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.lwjgl.system.NativeResource

close, free

Field Details

SIZEOF

public static final int SIZEOF

The struct size in bytes.

ALIGNOF

public static final int ALIGNOF

The struct alignment in bytes.

STYPE

public static final int STYPE

The struct member offsets.

PNEXT

public static final int PNEXT

The struct member offsets.

OVERALLOCATIONBEHAVIOR

public static final int OVERALLOCATIONBEHAVIOR

The struct member offsets.

Constructor Details

VkDeviceMemoryOverallocationCreateInfoAMD

public VkDeviceMemoryOverallocationCreateInfoAMD(ByteBuffer container)

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

sizeof

public int sizeof()

Specified by:

sizeof in class org.lwjgl.system.Struct<VkDeviceMemoryOverallocationCreateInfoAMD>

sType

public int sType()

a VkStructureType value identifying this structure.

pNext

public long pNext()

NULL or a pointer to a structure extending this structure.

overallocationBehavior

public int overallocationBehavior()

the desired overallocation behavior.

sType

public VkDeviceMemoryOverallocationCreateInfoAMD sType(int value)

Sets the specified value to the sType() field.

sType$Default

public VkDeviceMemoryOverallocationCreateInfoAMD sType$Default()

Sets the STRUCTURE_TYPE_DEVICE_MEMORY_OVERALLOCATION_CREATE_INFO_AMD value to the sType() field.

pNext

public VkDeviceMemoryOverallocationCreateInfoAMD pNext(long value)

Sets the specified value to the pNext() field.

overallocationBehavior

public VkDeviceMemoryOverallocationCreateInfoAMD overallocationBehavior(int value)

Sets the specified value to the overallocationBehavior() field.

set

public VkDeviceMemoryOverallocationCreateInfoAMD set(int sType,
 long pNext,
 int overallocationBehavior)

Initializes this struct with the specified values.

set

public VkDeviceMemoryOverallocationCreateInfoAMD set(VkDeviceMemoryOverallocationCreateInfoAMD src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static VkDeviceMemoryOverallocationCreateInfoAMD malloc()

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

calloc

public static VkDeviceMemoryOverallocationCreateInfoAMD calloc()

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

create

public static VkDeviceMemoryOverallocationCreateInfoAMD create()

Returns a new VkDeviceMemoryOverallocationCreateInfoAMD instance allocated with BufferUtils.

create

public static VkDeviceMemoryOverallocationCreateInfoAMD create(long address)

Returns a new VkDeviceMemoryOverallocationCreateInfoAMD instance for the specified memory address.

createSafe

public static @Nullable VkDeviceMemoryOverallocationCreateInfoAMD createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VkDeviceMemoryOverallocationCreateInfoAMD.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static VkDeviceMemoryOverallocationCreateInfoAMD.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static VkDeviceMemoryOverallocationCreateInfoAMD.Buffer create(int capacity)

Returns a new VkDeviceMemoryOverallocationCreateInfoAMD.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a VkDeviceMemoryOverallocationCreateInfoAMD.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

mallocStack

@Deprecated
public static VkDeviceMemoryOverallocationCreateInfoAMD mallocStack()

Deprecated.

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

callocStack

@Deprecated
public static VkDeviceMemoryOverallocationCreateInfoAMD callocStack()

Deprecated.

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

mallocStack

@Deprecated
public static VkDeviceMemoryOverallocationCreateInfoAMD mallocStack(org.lwjgl.system.MemoryStack stack)

Deprecated.

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

callocStack

@Deprecated
public static VkDeviceMemoryOverallocationCreateInfoAMD callocStack(org.lwjgl.system.MemoryStack stack)

Deprecated.

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

mallocStack

@Deprecated
public static VkDeviceMemoryOverallocationCreateInfoAMD.Buffer mallocStack(int capacity)

Deprecated.

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

callocStack

@Deprecated
public static VkDeviceMemoryOverallocationCreateInfoAMD.Buffer callocStack(int capacity)

Deprecated.

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

mallocStack

@Deprecated
public static VkDeviceMemoryOverallocationCreateInfoAMD.Buffer mallocStack(int capacity,
 org.lwjgl.system.MemoryStack stack)

Deprecated.

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

callocStack

@Deprecated
public static VkDeviceMemoryOverallocationCreateInfoAMD.Buffer callocStack(int capacity,
 org.lwjgl.system.MemoryStack stack)

Deprecated.

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

malloc

public static VkDeviceMemoryOverallocationCreateInfoAMD malloc(org.lwjgl.system.MemoryStack stack)

Returns a new VkDeviceMemoryOverallocationCreateInfoAMD instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

public static VkDeviceMemoryOverallocationCreateInfoAMD calloc(org.lwjgl.system.MemoryStack stack)

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

Parameters:

stack - the stack from which to allocate

malloc

public static VkDeviceMemoryOverallocationCreateInfoAMD.Buffer malloc(int capacity,
 org.lwjgl.system.MemoryStack stack)

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

public static VkDeviceMemoryOverallocationCreateInfoAMD.Buffer calloc(int capacity,
 org.lwjgl.system.MemoryStack stack)

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

nsType

public static int nsType(long struct)

Unsafe version of sType().

npNext

public static long npNext(long struct)

Unsafe version of pNext().

noverallocationBehavior

public static int noverallocationBehavior(long struct)

Unsafe version of overallocationBehavior().

nsType

public static void nsType(long struct,
 int value)

Unsafe version of sType.

npNext

public static void npNext(long struct,
 long value)

Unsafe version of pNext.

noverallocationBehavior

public static void noverallocationBehavior(long struct,
 int value)

Unsafe version of overallocationBehavior.