Package org.lwjgl.vulkan

Class VkPhysicalDeviceMultiviewProperties

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkPhysicalDeviceMultiviewProperties>

org.lwjgl.vulkan.VkPhysicalDeviceMultiviewProperties

All Implemented Interfaces:

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

Direct Known Subclasses:

VkPhysicalDeviceMultiviewPropertiesKHR

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

Structure describing multiview limits that can be supported by an implementation.

Description

If the VkPhysicalDeviceMultiviewProperties structure is included in the pNext chain of the VkPhysicalDeviceProperties2 structure passed to GetPhysicalDeviceProperties2, it is filled in with each corresponding implementation-dependent property.

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_PHYSICAL_DEVICE_MULTIVIEW_PROPERTIES

Layout

 struct VkPhysicalDeviceMultiviewProperties {
     VkStructureType sType();
     void * pNext();
     uint32_t maxMultiviewViewCount();
     uint32_t maxMultiviewInstanceIndex();
 }

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static VkPhysicalDeviceMultiviewProperties	calloc()	Returns a new VkPhysicalDeviceMultiviewProperties instance allocated with memCalloc.
static VkPhysicalDeviceMultiviewProperties.Buffer	calloc(int capacity)	Returns a new VkPhysicalDeviceMultiviewProperties.Buffer instance allocated with memCalloc.
static VkPhysicalDeviceMultiviewProperties.Buffer	calloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkPhysicalDeviceMultiviewProperties.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkPhysicalDeviceMultiviewProperties	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkPhysicalDeviceMultiviewProperties instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkPhysicalDeviceMultiviewProperties	callocStack()	Deprecated.
static VkPhysicalDeviceMultiviewProperties.Buffer	callocStack(int capacity)	Deprecated.
static VkPhysicalDeviceMultiviewProperties.Buffer	callocStack(int capacity, org.lwjgl.system.MemoryStack stack)	Deprecated.
static VkPhysicalDeviceMultiviewProperties	callocStack(org.lwjgl.system.MemoryStack stack)	Deprecated.
static VkPhysicalDeviceMultiviewProperties	create()	Returns a new VkPhysicalDeviceMultiviewProperties instance allocated with BufferUtils.
static VkPhysicalDeviceMultiviewProperties.Buffer	create(int capacity)	Returns a new VkPhysicalDeviceMultiviewProperties.Buffer instance allocated with BufferUtils.
static VkPhysicalDeviceMultiviewProperties	create(long address)	Returns a new VkPhysicalDeviceMultiviewProperties instance for the specified memory address.
static VkPhysicalDeviceMultiviewProperties.Buffer	create(long address, int capacity)	Create a VkPhysicalDeviceMultiviewProperties.Buffer instance at the specified memory.
static @Nullable VkPhysicalDeviceMultiviewProperties	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable VkPhysicalDeviceMultiviewProperties.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
static VkPhysicalDeviceMultiviewProperties	malloc()	Returns a new VkPhysicalDeviceMultiviewProperties instance allocated with memAlloc.
static VkPhysicalDeviceMultiviewProperties.Buffer	malloc(int capacity)	Returns a new VkPhysicalDeviceMultiviewProperties.Buffer instance allocated with memAlloc.
static VkPhysicalDeviceMultiviewProperties.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkPhysicalDeviceMultiviewProperties.Buffer instance allocated on the specified MemoryStack.
static VkPhysicalDeviceMultiviewProperties	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkPhysicalDeviceMultiviewProperties instance allocated on the specified MemoryStack.
static VkPhysicalDeviceMultiviewProperties	mallocStack()	Deprecated.
static VkPhysicalDeviceMultiviewProperties.Buffer	mallocStack(int capacity)	Deprecated.
static VkPhysicalDeviceMultiviewProperties.Buffer	mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)	Deprecated.
static VkPhysicalDeviceMultiviewProperties	mallocStack(org.lwjgl.system.MemoryStack stack)	Deprecated.
int	maxMultiviewInstanceIndex()	the maximum valid value of instance index allowed to be generated by a drawing command recorded within a subpass of a multiview render pass instance.
int	maxMultiviewViewCount()	one greater than the maximum view index that can be used in a subpass.
static int	nmaxMultiviewInstanceIndex(long struct)	Unsafe version of maxMultiviewInstanceIndex().
static int	nmaxMultiviewViewCount(long struct)	Unsafe version of maxMultiviewViewCount().
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.
long	pNext()	NULL or a pointer to a structure extending this structure.
VkPhysicalDeviceMultiviewProperties	pNext(long value)	Sets the specified value to the pNext() field.
VkPhysicalDeviceMultiviewProperties	set(int sType, long pNext)	Initializes this struct with the specified values.
VkPhysicalDeviceMultiviewProperties	set(VkPhysicalDeviceMultiviewProperties src)	Copies the specified struct data to this struct.
int	sizeof()
int	sType()	a VkStructureType value identifying this structure.
VkPhysicalDeviceMultiviewProperties	sType(int value)	Sets the specified value to the sType() field.
VkPhysicalDeviceMultiviewProperties	sType$Default()	Sets the STRUCTURE_TYPE_PHYSICAL_DEVICE_MULTIVIEW_PROPERTIES 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.

MAXMULTIVIEWVIEWCOUNT

public static final int MAXMULTIVIEWVIEWCOUNT

The struct member offsets.

MAXMULTIVIEWINSTANCEINDEX

public static final int MAXMULTIVIEWINSTANCEINDEX

The struct member offsets.

Constructor Details

VkPhysicalDeviceMultiviewProperties

public VkPhysicalDeviceMultiviewProperties(ByteBuffer container)

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

sType

public int sType()

a VkStructureType value identifying this structure.

pNext

public long pNext()

NULL or a pointer to a structure extending this structure.

maxMultiviewViewCount

public int maxMultiviewViewCount()

one greater than the maximum view index that can be used in a subpass.

maxMultiviewInstanceIndex

public int maxMultiviewInstanceIndex()

the maximum valid value of instance index allowed to be generated by a drawing command recorded within a subpass of a multiview render pass instance.

sType

public VkPhysicalDeviceMultiviewProperties sType(int value)

Sets the specified value to the sType() field.

sType$Default

public VkPhysicalDeviceMultiviewProperties sType$Default()

Sets the STRUCTURE_TYPE_PHYSICAL_DEVICE_MULTIVIEW_PROPERTIES value to the sType() field.

pNext

public VkPhysicalDeviceMultiviewProperties pNext(long value)

Sets the specified value to the pNext() field.

set

public VkPhysicalDeviceMultiviewProperties set(int sType,
 long pNext)

Initializes this struct with the specified values.

set

public VkPhysicalDeviceMultiviewProperties set(VkPhysicalDeviceMultiviewProperties src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static VkPhysicalDeviceMultiviewProperties malloc()

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

calloc

public static VkPhysicalDeviceMultiviewProperties calloc()

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

create

public static VkPhysicalDeviceMultiviewProperties create()

Returns a new VkPhysicalDeviceMultiviewProperties instance allocated with BufferUtils.

create

public static VkPhysicalDeviceMultiviewProperties create(long address)

Returns a new VkPhysicalDeviceMultiviewProperties instance for the specified memory address.

createSafe

public static @Nullable VkPhysicalDeviceMultiviewProperties createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VkPhysicalDeviceMultiviewProperties.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static VkPhysicalDeviceMultiviewProperties.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static VkPhysicalDeviceMultiviewProperties.Buffer create(int capacity)

Returns a new VkPhysicalDeviceMultiviewProperties.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a VkPhysicalDeviceMultiviewProperties.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

mallocStack

@Deprecated
public static VkPhysicalDeviceMultiviewProperties mallocStack()

Deprecated.

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

callocStack

@Deprecated
public static VkPhysicalDeviceMultiviewProperties callocStack()

Deprecated.

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

mallocStack

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

Deprecated.

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

callocStack

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

Deprecated.

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

mallocStack

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

Deprecated.

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

callocStack

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

Deprecated.

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

mallocStack

@Deprecated
public static VkPhysicalDeviceMultiviewProperties.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 VkPhysicalDeviceMultiviewProperties.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 VkPhysicalDeviceMultiviewProperties malloc(org.lwjgl.system.MemoryStack stack)

Returns a new VkPhysicalDeviceMultiviewProperties instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

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

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

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

nmaxMultiviewViewCount

public static int nmaxMultiviewViewCount(long struct)

Unsafe version of maxMultiviewViewCount().

nmaxMultiviewInstanceIndex

public static int nmaxMultiviewInstanceIndex(long struct)

Unsafe version of maxMultiviewInstanceIndex().

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.