Top Description Inners Fields Constructors Methods
org.lwjgl.vulkan

public Class VkDeviceMemoryOverallocationCreateInfoAMD

extends Struct<VkDeviceMemoryOverallocationCreateInfoAMD>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable
Imports
javax.annotation.*, java.nio.*, org.lwjgl.*, org.lwjgl.system.*
Specify memory overallocation behavior for a Vulkan device.
Valid Usage (Implicit)

Layout


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

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class
VkDeviceMemoryOverallocationCreateInfoAMD.Buffer

An array of VkDeviceMemoryOverallocationCreateInfoAMD structs.

Field Summary

Modifier and TypeField and Description
public static final int
ALIGNOF

The struct alignment in bytes.

public static final int
OVERALLOCATIONBEHAVIOR

The struct member offsets.

public static final int
PNEXT

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

public
VkDeviceMemoryOverallocationCreateInfoAMD(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public static VkDeviceMemoryOverallocationCreateInfoAMD
calloc()

Returns a new VkDeviceMemoryOverallocationCreateInfoAMD instance allocated with memCalloc.

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

Returns a new VkDeviceMemoryOverallocationCreateInfoAMD.Buffer instance allocated with memCalloc.

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

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

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

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

public static VkDeviceMemoryOverallocationCreateInfoAMD
callocStack()

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

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

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

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

Returns a new VkDeviceMemoryOverallocationCreateInfoAMD instance allocated with BufferUtils.

public static VkDeviceMemoryOverallocationCreateInfoAMD
create(long address)

Returns a new VkDeviceMemoryOverallocationCreateInfoAMD instance for the specified memory address.

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

Returns a new VkDeviceMemoryOverallocationCreateInfoAMD.Buffer instance allocated with BufferUtils.

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

Create a VkDeviceMemoryOverallocationCreateInfoAMD.Buffer instance at the specified memory.

public static VkDeviceMemoryOverallocationCreateInfoAMD
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public static VkDeviceMemoryOverallocationCreateInfoAMD
malloc()

Returns a new VkDeviceMemoryOverallocationCreateInfoAMD instance allocated with memAlloc.

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

Returns a new VkDeviceMemoryOverallocationCreateInfoAMD.Buffer instance allocated with memAlloc.

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

Returns a new VkDeviceMemoryOverallocationCreateInfoAMD instance allocated on the specified MemoryStack.

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

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

public static VkDeviceMemoryOverallocationCreateInfoAMD
mallocStack()

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

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

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

Deprecated
Deprecated for removal in 3.4.0.
public static int
noverallocationBehavior(long struct)

Unsafe version of overallocationBehavior.

public static void
noverallocationBehavior(long struct, int value)

Unsafe version of overallocationBehavior.

public static long
npNext(long struct)

Unsafe version of pNext.

public static void
npNext(long struct, long value)

Unsafe version of pNext.

public static int
nsType(long struct)

Unsafe version of sType.

public static void
nsType(long struct, int value)

Unsafe version of sType.

public int
overallocationBehavior()

the desired overallocation behavior.

public VkDeviceMemoryOverallocationCreateInfoAMD
overallocationBehavior(int value)

Sets the specified value to the overallocationBehavior field.

public long
pNext()

NULL or a pointer to a structure extending this structure.

public VkDeviceMemoryOverallocationCreateInfoAMD
pNext(long value)

Sets the specified value to the pNext field.

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

Initializes this struct with the specified values.

public VkDeviceMemoryOverallocationCreateInfoAMD

Returns:

this struct
set(VkDeviceMemoryOverallocationCreateInfoAMD
the source struct
src)

Copies the specified struct data to this struct.

public int
sizeof()

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

Returns sizeof(struct).
public int
sType()

a VkStructureType value identifying this structure.

public VkDeviceMemoryOverallocationCreateInfoAMD
sType(int value)

Sets the specified value to the sType field.

public VkDeviceMemoryOverallocationCreateInfoAMD
sType$Default()

Sets the STRUCTURE_TYPE_DEVICE_MEMORY_OVERALLOCATION_CREATE_INFO_AMD value to the sType field.

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.

OVERALLOCATIONBEHAVIORback to summary
public static final int OVERALLOCATIONBEHAVIOR

The struct member offsets.

PNEXTback to summary
public static final int PNEXT

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

VkDeviceMemoryOverallocationCreateInfoAMDback to summary
protected VkDeviceMemoryOverallocationCreateInfoAMD(long address, ByteBuffer container)
VkDeviceMemoryOverallocationCreateInfoAMDback to summary
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 Detail

callocback to summary
public static VkDeviceMemoryOverallocationCreateInfoAMD calloc()

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

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

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static VkDeviceMemoryOverallocationCreateInfoAMD calloc(MemoryStack stack)

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

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

Deprecated

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

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

Deprecated

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

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

Deprecated

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

Annotations
@Deprecated
callocStackback to summary
public static VkDeviceMemoryOverallocationCreateInfoAMD.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 VkDeviceMemoryOverallocationCreateInfoAMD 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 VkDeviceMemoryOverallocationCreateInfoAMD create()

Returns a new VkDeviceMemoryOverallocationCreateInfoAMD instance allocated with BufferUtils.

createback to summary
public static VkDeviceMemoryOverallocationCreateInfoAMD create(long address)

Returns a new VkDeviceMemoryOverallocationCreateInfoAMD instance for the specified memory address.

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

Returns a new VkDeviceMemoryOverallocationCreateInfoAMD.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a VkDeviceMemoryOverallocationCreateInfoAMD.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static VkDeviceMemoryOverallocationCreateInfoAMD createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

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

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

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

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static VkDeviceMemoryOverallocationCreateInfoAMD malloc(MemoryStack stack)

Returns a new VkDeviceMemoryOverallocationCreateInfoAMD instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

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

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

Deprecated

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

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

Deprecated

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

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

Deprecated

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

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

Deprecated

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

Annotations
@Deprecated
noverallocationBehaviorback to summary
public static int noverallocationBehavior(long struct)

Unsafe version of overallocationBehavior.

noverallocationBehaviorback to summary
public static void noverallocationBehavior(long struct, int value)

Unsafe version of overallocationBehavior.

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.

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.

overallocationBehaviorback to summary
public int overallocationBehavior()

the desired overallocation behavior.

Annotations
@NativeType:VkMemoryOverallocationBehaviorAMD
overallocationBehaviorback to summary
public VkDeviceMemoryOverallocationCreateInfoAMD overallocationBehavior(int value)

Sets the specified value to the overallocationBehavior 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 VkDeviceMemoryOverallocationCreateInfoAMD pNext(long value)

Sets the specified value to the pNext field.

setback to summary
public VkDeviceMemoryOverallocationCreateInfoAMD set(int sType, long pNext, int overallocationBehavior)

Initializes this struct with the specified values.

setback to summary
public VkDeviceMemoryOverallocationCreateInfoAMD set(VkDeviceMemoryOverallocationCreateInfoAMD src)

Copies the specified struct data to this struct.

Parameters
src:VkDeviceMemoryOverallocationCreateInfoAMD

the source struct

Returns:VkDeviceMemoryOverallocationCreateInfoAMD

this struct

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

Sets the specified value to the sType field.

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

Sets the STRUCTURE_TYPE_DEVICE_MEMORY_OVERALLOCATION_CREATE_INFO_AMD value to the sType field.

org.lwjgl.vulkan back to summary

public Class VkDeviceMemoryOverallocationCreateInfoAMD.Buffer

extends StructBuffer<VkDeviceMemoryOverallocationCreateInfoAMD, VkDeviceMemoryOverallocationCreateInfoAMD.Buffer>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable
An array of VkDeviceMemoryOverallocationCreateInfoAMD structs.

Field Summary

Modifier and TypeField and Description
private static final VkDeviceMemoryOverallocationCreateInfoAMD
ELEMENT_FACTORY

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new VkDeviceMemoryOverallocationCreateInfoAMD.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 VkDeviceMemoryOverallocationCreateInfoAMD
getElementFactory()

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

public int

Returns:

the value of the VkDeviceMemoryOverallocationCreateInfoAMD#overallocationBehavior field.
overallocationBehavior()

public VkDeviceMemoryOverallocationCreateInfoAMD.Buffer
overallocationBehavior(int value)

Sets the specified value to the VkDeviceMemoryOverallocationCreateInfoAMD#overallocationBehavior field.

public long

Returns:

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

public VkDeviceMemoryOverallocationCreateInfoAMD.Buffer
pNext(long value)

Sets the specified value to the VkDeviceMemoryOverallocationCreateInfoAMD#pNext field.

protected VkDeviceMemoryOverallocationCreateInfoAMD.Buffer
self()

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

public int

Returns:

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

public VkDeviceMemoryOverallocationCreateInfoAMD.Buffer
sType(int value)

Sets the specified value to the VkDeviceMemoryOverallocationCreateInfoAMD#sType field.

public VkDeviceMemoryOverallocationCreateInfoAMD.Buffer
sType$Default()

Sets the STRUCTURE_TYPE_DEVICE_MEMORY_OVERALLOCATION_CREATE_INFO_AMD value to the VkDeviceMemoryOverallocationCreateInfoAMD#sType field.

Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final VkDeviceMemoryOverallocationCreateInfoAMD ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

Creates a new VkDeviceMemoryOverallocationCreateInfoAMD.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 VkDeviceMemoryOverallocationCreateInfoAMD#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 VkDeviceMemoryOverallocationCreateInfoAMD getElementFactory()

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

Annotations
@Override
overallocationBehaviorback to summary
public int overallocationBehavior()
Returns:int

the value of the VkDeviceMemoryOverallocationCreateInfoAMD#overallocationBehavior field.

Annotations
@NativeType:VkMemoryOverallocationBehaviorAMD
overallocationBehaviorback to summary
public VkDeviceMemoryOverallocationCreateInfoAMD.Buffer overallocationBehavior(int value)

Sets the specified value to the VkDeviceMemoryOverallocationCreateInfoAMD#overallocationBehavior field.

pNextback to summary
public long pNext()
Returns:long

the value of the VkDeviceMemoryOverallocationCreateInfoAMD#pNext field.

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

Sets the specified value to the VkDeviceMemoryOverallocationCreateInfoAMD#pNext field.

selfback to summary
protected VkDeviceMemoryOverallocationCreateInfoAMD.Buffer self()

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

Annotations
@Override
sTypeback to summary
public int sType()
Returns:int

the value of the VkDeviceMemoryOverallocationCreateInfoAMD#sType field.

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

Sets the specified value to the VkDeviceMemoryOverallocationCreateInfoAMD#sType field.

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

Sets the STRUCTURE_TYPE_DEVICE_MEMORY_OVERALLOCATION_CREATE_INFO_AMD value to the VkDeviceMemoryOverallocationCreateInfoAMD#sType field.