Package org.lwjgl.vulkan

Class VkPhysicalDeviceLayeredApiPropertiesKHR

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkPhysicalDeviceLayeredApiPropertiesKHR>

org.lwjgl.vulkan.VkPhysicalDeviceLayeredApiPropertiesKHR

All Implemented Interfaces:

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

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

Structure describing a single layered implementation underneath the Vulkan physical device.

Description

If layeredAPI is PHYSICAL_DEVICE_LAYERED_API_VULKAN_KHR, additional Vulkan-specific information can be queried by including the VkPhysicalDeviceLayeredApiVulkanPropertiesKHR structure in the pNext chain. Otherwise if such a structure is included in the pNext chain, it is ignored.

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_PHYSICAL_DEVICE_LAYERED_API_PROPERTIES_KHR
• pNext must be NULL or a pointer to a valid instance of VkPhysicalDeviceLayeredApiVulkanPropertiesKHR
• The sType value of each struct in the pNext chain must be unique

See Also

VkPhysicalDeviceLayeredApiPropertiesListKHR

Layout

 struct VkPhysicalDeviceLayeredApiPropertiesKHR {
     VkStructureType sType();
     void * pNext();
     uint32_t vendorID();
     uint32_t deviceID();
     VkPhysicalDeviceLayeredApiKHR layeredAPI();
     char deviceName()[VK_MAX_PHYSICAL_DEVICE_NAME_SIZE];
 }

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	VkPhysicalDeviceLayeredApiPropertiesKHR.Buffer	An array of VkPhysicalDeviceLayeredApiPropertiesKHR 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	DEVICEID	The struct member offsets.
static final int	DEVICENAME	The struct member offsets.
static final int	LAYEREDAPI	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.
static final int	VENDORID	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
VkPhysicalDeviceLayeredApiPropertiesKHR(ByteBuffer container)	Creates a VkPhysicalDeviceLayeredApiPropertiesKHR instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and Type	Method	Description
static VkPhysicalDeviceLayeredApiPropertiesKHR	calloc()	Returns a new VkPhysicalDeviceLayeredApiPropertiesKHR instance allocated with memCalloc.
static VkPhysicalDeviceLayeredApiPropertiesKHR.Buffer	calloc(int capacity)	Returns a new VkPhysicalDeviceLayeredApiPropertiesKHR.Buffer instance allocated with memCalloc.
static VkPhysicalDeviceLayeredApiPropertiesKHR.Buffer	calloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkPhysicalDeviceLayeredApiPropertiesKHR.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkPhysicalDeviceLayeredApiPropertiesKHR	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkPhysicalDeviceLayeredApiPropertiesKHR instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkPhysicalDeviceLayeredApiPropertiesKHR	create()	Returns a new VkPhysicalDeviceLayeredApiPropertiesKHR instance allocated with BufferUtils.
static VkPhysicalDeviceLayeredApiPropertiesKHR.Buffer	create(int capacity)	Returns a new VkPhysicalDeviceLayeredApiPropertiesKHR.Buffer instance allocated with BufferUtils.
static VkPhysicalDeviceLayeredApiPropertiesKHR	create(long address)	Returns a new VkPhysicalDeviceLayeredApiPropertiesKHR instance for the specified memory address.
static VkPhysicalDeviceLayeredApiPropertiesKHR.Buffer	create(long address, int capacity)	Create a VkPhysicalDeviceLayeredApiPropertiesKHR.Buffer instance at the specified memory.
static @Nullable VkPhysicalDeviceLayeredApiPropertiesKHR	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable VkPhysicalDeviceLayeredApiPropertiesKHR.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
int	deviceID()	a unique identifier for the layered implementation among devices available from the vendor.
ByteBuffer	deviceName()	an array of MAX_PHYSICAL_DEVICE_NAME_SIZE char containing a null-terminated UTF-8 string which is the name of the device.
String	deviceNameString()	an array of MAX_PHYSICAL_DEVICE_NAME_SIZE char containing a null-terminated UTF-8 string which is the name of the device.
int	layeredAPI()	a VkPhysicalDeviceLayeredApiKHR specifying the API implemented by the layered implementation.
static VkPhysicalDeviceLayeredApiPropertiesKHR	malloc()	Returns a new VkPhysicalDeviceLayeredApiPropertiesKHR instance allocated with memAlloc.
static VkPhysicalDeviceLayeredApiPropertiesKHR.Buffer	malloc(int capacity)	Returns a new VkPhysicalDeviceLayeredApiPropertiesKHR.Buffer instance allocated with memAlloc.
static VkPhysicalDeviceLayeredApiPropertiesKHR.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkPhysicalDeviceLayeredApiPropertiesKHR.Buffer instance allocated on the specified MemoryStack.
static VkPhysicalDeviceLayeredApiPropertiesKHR	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkPhysicalDeviceLayeredApiPropertiesKHR instance allocated on the specified MemoryStack.
static int	ndeviceID(long struct)	Unsafe version of deviceID().
static ByteBuffer	ndeviceName(long struct)	Unsafe version of deviceName().
static String	ndeviceNameString(long struct)	Unsafe version of deviceNameString().
static int	nlayeredAPI(long struct)	Unsafe version of layeredAPI().
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.
static int	nvendorID(long struct)	Unsafe version of vendorID().
long	pNext()	NULL or a pointer to a structure extending this structure.
VkPhysicalDeviceLayeredApiPropertiesKHR	pNext(long value)	Sets the specified value to the pNext() field.
VkPhysicalDeviceLayeredApiPropertiesKHR	pNext(VkPhysicalDeviceLayeredApiVulkanPropertiesKHR value)	Prepends the specified VkPhysicalDeviceLayeredApiVulkanPropertiesKHR value to the pNext chain.
VkPhysicalDeviceLayeredApiPropertiesKHR	set(int sType, long pNext)	Initializes this struct with the specified values.
VkPhysicalDeviceLayeredApiPropertiesKHR	set(VkPhysicalDeviceLayeredApiPropertiesKHR src)	Copies the specified struct data to this struct.
int	sizeof()
int	sType()	a VkStructureType value identifying this structure.
VkPhysicalDeviceLayeredApiPropertiesKHR	sType(int value)	Sets the specified value to the sType() field.
VkPhysicalDeviceLayeredApiPropertiesKHR	sType$Default()	Sets the STRUCTURE_TYPE_PHYSICAL_DEVICE_LAYERED_API_PROPERTIES_KHR value to the sType() field.
int	vendorID()	a unique identifier for the vendor of the layered implementation.

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.

VENDORID

public static final int VENDORID

The struct member offsets.

DEVICEID

public static final int DEVICEID

The struct member offsets.

LAYEREDAPI

public static final int LAYEREDAPI

The struct member offsets.

DEVICENAME

public static final int DEVICENAME

The struct member offsets.

Constructor Details

VkPhysicalDeviceLayeredApiPropertiesKHR

public VkPhysicalDeviceLayeredApiPropertiesKHR(ByteBuffer container)

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

sType

public int sType()

a VkStructureType value identifying this structure.

pNext

public long pNext()

NULL or a pointer to a structure extending this structure.

vendorID

public int vendorID()

a unique identifier for the vendor of the layered implementation.

deviceID

public int deviceID()

a unique identifier for the layered implementation among devices available from the vendor.

layeredAPI

public int layeredAPI()

a VkPhysicalDeviceLayeredApiKHR specifying the API implemented by the layered implementation.

deviceName

public ByteBuffer deviceName()

an array of MAX_PHYSICAL_DEVICE_NAME_SIZE char containing a null-terminated UTF-8 string which is the name of the device.

deviceNameString

public String deviceNameString()

an array of MAX_PHYSICAL_DEVICE_NAME_SIZE char containing a null-terminated UTF-8 string which is the name of the device.

sType

public VkPhysicalDeviceLayeredApiPropertiesKHR sType(int value)

Sets the specified value to the sType() field.

sType$Default

public VkPhysicalDeviceLayeredApiPropertiesKHR sType$Default()

Sets the STRUCTURE_TYPE_PHYSICAL_DEVICE_LAYERED_API_PROPERTIES_KHR value to the sType() field.

pNext

public VkPhysicalDeviceLayeredApiPropertiesKHR pNext(long value)

Sets the specified value to the pNext() field.

pNext

public VkPhysicalDeviceLayeredApiPropertiesKHR pNext(VkPhysicalDeviceLayeredApiVulkanPropertiesKHR value)

Prepends the specified VkPhysicalDeviceLayeredApiVulkanPropertiesKHR value to the pNext chain.

set

public VkPhysicalDeviceLayeredApiPropertiesKHR set(int sType,
 long pNext)

Initializes this struct with the specified values.

set

public VkPhysicalDeviceLayeredApiPropertiesKHR set(VkPhysicalDeviceLayeredApiPropertiesKHR src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static VkPhysicalDeviceLayeredApiPropertiesKHR malloc()

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

calloc

public static VkPhysicalDeviceLayeredApiPropertiesKHR calloc()

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

create

public static VkPhysicalDeviceLayeredApiPropertiesKHR create()

Returns a new VkPhysicalDeviceLayeredApiPropertiesKHR instance allocated with BufferUtils.

create

public static VkPhysicalDeviceLayeredApiPropertiesKHR create(long address)

Returns a new VkPhysicalDeviceLayeredApiPropertiesKHR instance for the specified memory address.

createSafe

public static @Nullable VkPhysicalDeviceLayeredApiPropertiesKHR createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VkPhysicalDeviceLayeredApiPropertiesKHR.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static VkPhysicalDeviceLayeredApiPropertiesKHR.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static VkPhysicalDeviceLayeredApiPropertiesKHR.Buffer create(int capacity)

Returns a new VkPhysicalDeviceLayeredApiPropertiesKHR.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a VkPhysicalDeviceLayeredApiPropertiesKHR.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

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

Returns a new VkPhysicalDeviceLayeredApiPropertiesKHR instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

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

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

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

nvendorID

public static int nvendorID(long struct)

Unsafe version of vendorID().

ndeviceID

public static int ndeviceID(long struct)

Unsafe version of deviceID().

nlayeredAPI

public static int nlayeredAPI(long struct)

Unsafe version of layeredAPI().

ndeviceName

public static ByteBuffer ndeviceName(long struct)

Unsafe version of deviceName().

ndeviceNameString

public static String ndeviceNameString(long struct)

Unsafe version of deviceNameString().

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.