Package org.lwjgl.vulkan

Class VkDeviceDeviceMemoryReportCreateInfoEXT

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkDeviceDeviceMemoryReportCreateInfoEXT>

org.lwjgl.vulkan.VkDeviceDeviceMemoryReportCreateInfoEXT

All Implemented Interfaces:

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

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

Register device memory report callbacks for a Vulkan device.

Description

The callback may be called from multiple threads simultaneously.

The callback must be called only once by the implementation when a VkDeviceMemoryReportEventTypeEXT event occurs.

Note

The callback could be called from a background thread other than the thread calling the Vulkan commands.

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_DEVICE_DEVICE_MEMORY_REPORT_CREATE_INFO_EXT
• flags must be 0
• pfnUserCallback must be a valid VkDeviceMemoryReportCallbackEXT value
• pUserData must be a pointer value

See Also

VkDeviceMemoryReportCallbackEXT

Layout

 struct VkDeviceDeviceMemoryReportCreateInfoEXT {
     VkStructureType sType();
     void const * pNext();
     VkDeviceMemoryReportFlagsEXT flags();
     PFN_vkDeviceMemoryReportCallbackEXT pfnUserCallback();
     void * pUserData();
 }

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	VkDeviceDeviceMemoryReportCreateInfoEXT.Buffer	An array of VkDeviceDeviceMemoryReportCreateInfoEXT 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	FLAGS	The struct member offsets.
static final int	PFNUSERCALLBACK	The struct member offsets.
static final int	PNEXT	The struct member offsets.
static final int	PUSERDATA	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
VkDeviceDeviceMemoryReportCreateInfoEXT(ByteBuffer container)	Creates a VkDeviceDeviceMemoryReportCreateInfoEXT instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and Type	Method	Description
static VkDeviceDeviceMemoryReportCreateInfoEXT	calloc()	Returns a new VkDeviceDeviceMemoryReportCreateInfoEXT instance allocated with memCalloc.
static VkDeviceDeviceMemoryReportCreateInfoEXT.Buffer	calloc(int capacity)	Returns a new VkDeviceDeviceMemoryReportCreateInfoEXT.Buffer instance allocated with memCalloc.
static VkDeviceDeviceMemoryReportCreateInfoEXT.Buffer	calloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkDeviceDeviceMemoryReportCreateInfoEXT.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkDeviceDeviceMemoryReportCreateInfoEXT	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkDeviceDeviceMemoryReportCreateInfoEXT instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkDeviceDeviceMemoryReportCreateInfoEXT	create()	Returns a new VkDeviceDeviceMemoryReportCreateInfoEXT instance allocated with BufferUtils.
static VkDeviceDeviceMemoryReportCreateInfoEXT.Buffer	create(int capacity)	Returns a new VkDeviceDeviceMemoryReportCreateInfoEXT.Buffer instance allocated with BufferUtils.
static VkDeviceDeviceMemoryReportCreateInfoEXT	create(long address)	Returns a new VkDeviceDeviceMemoryReportCreateInfoEXT instance for the specified memory address.
static VkDeviceDeviceMemoryReportCreateInfoEXT.Buffer	create(long address, int capacity)	Create a VkDeviceDeviceMemoryReportCreateInfoEXT.Buffer instance at the specified memory.
static @Nullable VkDeviceDeviceMemoryReportCreateInfoEXT	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable VkDeviceDeviceMemoryReportCreateInfoEXT.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
int	flags()	0 and reserved for future use.
VkDeviceDeviceMemoryReportCreateInfoEXT	flags(int value)	Sets the specified value to the flags() field.
static VkDeviceDeviceMemoryReportCreateInfoEXT	malloc()	Returns a new VkDeviceDeviceMemoryReportCreateInfoEXT instance allocated with memAlloc.
static VkDeviceDeviceMemoryReportCreateInfoEXT.Buffer	malloc(int capacity)	Returns a new VkDeviceDeviceMemoryReportCreateInfoEXT.Buffer instance allocated with memAlloc.
static VkDeviceDeviceMemoryReportCreateInfoEXT.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkDeviceDeviceMemoryReportCreateInfoEXT.Buffer instance allocated on the specified MemoryStack.
static VkDeviceDeviceMemoryReportCreateInfoEXT	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkDeviceDeviceMemoryReportCreateInfoEXT instance allocated on the specified MemoryStack.
static int	nflags(long struct)	Unsafe version of flags().
static void	nflags(long struct, int value)	Unsafe version of flags.
static VkDeviceMemoryReportCallbackEXT	npfnUserCallback(long struct)	Unsafe version of pfnUserCallback().
static void	npfnUserCallback(long struct, VkDeviceMemoryReportCallbackEXTI value)	Unsafe version of pfnUserCallback.
static long	npNext(long struct)	Unsafe version of pNext().
static void	npNext(long struct, long value)	Unsafe version of pNext.
static long	npUserData(long struct)	Unsafe version of pUserData().
static void	npUserData(long struct, long value)	Unsafe version of pUserData.
static int	nsType(long struct)	Unsafe version of sType().
static void	nsType(long struct, int value)	Unsafe version of sType.
VkDeviceMemoryReportCallbackEXT	pfnUserCallback()	the application callback function to call.
VkDeviceDeviceMemoryReportCreateInfoEXT	pfnUserCallback(VkDeviceMemoryReportCallbackEXTI value)	Sets the specified value to the pfnUserCallback() field.
long	pNext()	NULL or a pointer to a structure extending this structure.
VkDeviceDeviceMemoryReportCreateInfoEXT	pNext(long value)	Sets the specified value to the pNext() field.
long	pUserData()	user data to be passed to the callback.
VkDeviceDeviceMemoryReportCreateInfoEXT	pUserData(long value)	Sets the specified value to the pUserData() field.
VkDeviceDeviceMemoryReportCreateInfoEXT	set(int sType, long pNext, int flags, VkDeviceMemoryReportCallbackEXTI pfnUserCallback, long pUserData)	Initializes this struct with the specified values.
VkDeviceDeviceMemoryReportCreateInfoEXT	set(VkDeviceDeviceMemoryReportCreateInfoEXT src)	Copies the specified struct data to this struct.
int	sizeof()
int	sType()	a VkStructureType value identifying this structure.
VkDeviceDeviceMemoryReportCreateInfoEXT	sType(int value)	Sets the specified value to the sType() field.
VkDeviceDeviceMemoryReportCreateInfoEXT	sType$Default()	Sets the STRUCTURE_TYPE_DEVICE_DEVICE_MEMORY_REPORT_CREATE_INFO_EXT value to the sType() field.
static void	validate(long struct)	Validates pointer members that should not be NULL.

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.

FLAGS

public static final int FLAGS

The struct member offsets.

PFNUSERCALLBACK

public static final int PFNUSERCALLBACK

The struct member offsets.

PUSERDATA

public static final int PUSERDATA

The struct member offsets.

Constructor Details

VkDeviceDeviceMemoryReportCreateInfoEXT

public VkDeviceDeviceMemoryReportCreateInfoEXT(ByteBuffer container)

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

sType

public int sType()

a VkStructureType value identifying this structure.

pNext

public long pNext()

NULL or a pointer to a structure extending this structure.

flags

public int flags()

0 and reserved for future use.

pfnUserCallback

public VkDeviceMemoryReportCallbackEXT pfnUserCallback()

the application callback function to call.

pUserData

public long pUserData()

user data to be passed to the callback.

sType

public VkDeviceDeviceMemoryReportCreateInfoEXT sType(int value)

Sets the specified value to the sType() field.

sType$Default

public VkDeviceDeviceMemoryReportCreateInfoEXT sType$Default()

Sets the STRUCTURE_TYPE_DEVICE_DEVICE_MEMORY_REPORT_CREATE_INFO_EXT value to the sType() field.

pNext

public VkDeviceDeviceMemoryReportCreateInfoEXT pNext(long value)

Sets the specified value to the pNext() field.

flags

public VkDeviceDeviceMemoryReportCreateInfoEXT flags(int value)

Sets the specified value to the flags() field.

pfnUserCallback

public VkDeviceDeviceMemoryReportCreateInfoEXT pfnUserCallback(VkDeviceMemoryReportCallbackEXTI value)

Sets the specified value to the pfnUserCallback() field.

pUserData

public VkDeviceDeviceMemoryReportCreateInfoEXT pUserData(long value)

Sets the specified value to the pUserData() field.

set

public VkDeviceDeviceMemoryReportCreateInfoEXT set(int sType,
 long pNext,
 int flags,
 VkDeviceMemoryReportCallbackEXTI pfnUserCallback,
 long pUserData)

Initializes this struct with the specified values.

set

public VkDeviceDeviceMemoryReportCreateInfoEXT set(VkDeviceDeviceMemoryReportCreateInfoEXT src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static VkDeviceDeviceMemoryReportCreateInfoEXT malloc()

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

calloc

public static VkDeviceDeviceMemoryReportCreateInfoEXT calloc()

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

create

public static VkDeviceDeviceMemoryReportCreateInfoEXT create()

Returns a new VkDeviceDeviceMemoryReportCreateInfoEXT instance allocated with BufferUtils.

create

public static VkDeviceDeviceMemoryReportCreateInfoEXT create(long address)

Returns a new VkDeviceDeviceMemoryReportCreateInfoEXT instance for the specified memory address.

createSafe

public static @Nullable VkDeviceDeviceMemoryReportCreateInfoEXT createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VkDeviceDeviceMemoryReportCreateInfoEXT.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static VkDeviceDeviceMemoryReportCreateInfoEXT.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static VkDeviceDeviceMemoryReportCreateInfoEXT.Buffer create(int capacity)

Returns a new VkDeviceDeviceMemoryReportCreateInfoEXT.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a VkDeviceDeviceMemoryReportCreateInfoEXT.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

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

Returns a new VkDeviceDeviceMemoryReportCreateInfoEXT instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

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

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

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

nflags

public static int nflags(long struct)

Unsafe version of flags().

npfnUserCallback

public static VkDeviceMemoryReportCallbackEXT npfnUserCallback(long struct)

Unsafe version of pfnUserCallback().

npUserData

public static long npUserData(long struct)

Unsafe version of pUserData().

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.

nflags

public static void nflags(long struct,
 int value)

Unsafe version of flags.

npfnUserCallback

public static void npfnUserCallback(long struct,
 VkDeviceMemoryReportCallbackEXTI value)

Unsafe version of pfnUserCallback.

npUserData

public static void npUserData(long struct,
 long value)

Unsafe version of pUserData.

validate

public static void validate(long struct)

Validates pointer members that should not be NULL.

Parameters:

struct - the struct to validate