Package org.lwjgl.vulkan

Class VkPhysicalDeviceMultiviewFeatures

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkPhysicalDeviceMultiviewFeatures>

org.lwjgl.vulkan.VkPhysicalDeviceMultiviewFeatures

All Implemented Interfaces:

AutoCloseable, NativeResource, Pointer

Direct Known Subclasses:

VkPhysicalDeviceMultiviewFeaturesKHR

public class VkPhysicalDeviceMultiviewFeatures
extends Struct<VkPhysicalDeviceMultiviewFeatures>
implements NativeResource

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

Description

If the VkPhysicalDeviceMultiviewFeatures structure is included in the pNext chain of the VkPhysicalDeviceFeatures2 structure passed to GetPhysicalDeviceFeatures2, it is filled in to indicate whether each corresponding feature is supported. VkPhysicalDeviceMultiviewFeatures can also be used in the pNext chain of VkDeviceCreateInfo to selectively enable these features.

Valid Usage

• If multiviewGeometryShader is enabled then multiview must also be enabled
• If multiviewTessellationShader is enabled then multiview must also be enabled

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_PHYSICAL_DEVICE_MULTIVIEW_FEATURES

Layout

 struct VkPhysicalDeviceMultiviewFeatures {
     VkStructureType sType();
     void * pNext();
     VkBool32 multiview();
     VkBool32 multiviewGeometryShader();
     VkBool32 multiviewTessellationShader();
 }

Nested Class Summary

Nested Classes

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

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

Struct.StructValidation

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

Pointer.Default

Field Summary

Fields

Modifier and Type	Field	Description
static final int	ALIGNOF	The struct alignment in bytes.
static final int	MULTIVIEW	The struct member offsets.
static final int	MULTIVIEWGEOMETRYSHADER	The struct member offsets.
static final int	MULTIVIEWTESSELLATIONSHADER	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
VkPhysicalDeviceMultiviewFeatures(ByteBuffer container)	Creates a VkPhysicalDeviceMultiviewFeatures instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and Type	Method	Description
static VkPhysicalDeviceMultiviewFeatures	calloc()	Returns a new VkPhysicalDeviceMultiviewFeatures instance allocated with memCalloc.
static VkPhysicalDeviceMultiviewFeatures.Buffer	calloc(int capacity)	Returns a new VkPhysicalDeviceMultiviewFeatures.Buffer instance allocated with memCalloc.
static VkPhysicalDeviceMultiviewFeatures.Buffer	calloc(int capacity, MemoryStack stack)	Returns a new VkPhysicalDeviceMultiviewFeatures.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkPhysicalDeviceMultiviewFeatures	calloc(MemoryStack stack)	Returns a new VkPhysicalDeviceMultiviewFeatures instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkPhysicalDeviceMultiviewFeatures	callocStack()	Deprecated.
static VkPhysicalDeviceMultiviewFeatures.Buffer	callocStack(int capacity)	Deprecated.
static VkPhysicalDeviceMultiviewFeatures.Buffer	callocStack(int capacity, MemoryStack stack)	Deprecated.
static VkPhysicalDeviceMultiviewFeatures	callocStack(MemoryStack stack)	Deprecated.
static VkPhysicalDeviceMultiviewFeatures	create()	Returns a new VkPhysicalDeviceMultiviewFeatures instance allocated with BufferUtils.
static VkPhysicalDeviceMultiviewFeatures.Buffer	create(int capacity)	Returns a new VkPhysicalDeviceMultiviewFeatures.Buffer instance allocated with BufferUtils.
static VkPhysicalDeviceMultiviewFeatures	create(long address)	Returns a new VkPhysicalDeviceMultiviewFeatures instance for the specified memory address.
static VkPhysicalDeviceMultiviewFeatures.Buffer	create(long address, int capacity)	Create a VkPhysicalDeviceMultiviewFeatures.Buffer instance at the specified memory.
static VkPhysicalDeviceMultiviewFeatures	createSafe(long address)	Like create, but returns null if address is NULL.
static VkPhysicalDeviceMultiviewFeatures.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
static VkPhysicalDeviceMultiviewFeatures	malloc()	Returns a new VkPhysicalDeviceMultiviewFeatures instance allocated with memAlloc.
static VkPhysicalDeviceMultiviewFeatures.Buffer	malloc(int capacity)	Returns a new VkPhysicalDeviceMultiviewFeatures.Buffer instance allocated with memAlloc.
static VkPhysicalDeviceMultiviewFeatures.Buffer	malloc(int capacity, MemoryStack stack)	Returns a new VkPhysicalDeviceMultiviewFeatures.Buffer instance allocated on the specified MemoryStack.
static VkPhysicalDeviceMultiviewFeatures	malloc(MemoryStack stack)	Returns a new VkPhysicalDeviceMultiviewFeatures instance allocated on the specified MemoryStack.
static VkPhysicalDeviceMultiviewFeatures	mallocStack()	Deprecated.
static VkPhysicalDeviceMultiviewFeatures.Buffer	mallocStack(int capacity)	Deprecated.
static VkPhysicalDeviceMultiviewFeatures.Buffer	mallocStack(int capacity, MemoryStack stack)	Deprecated.
static VkPhysicalDeviceMultiviewFeatures	mallocStack(MemoryStack stack)	Deprecated.
boolean	multiview()	specifies whether the implementation supports multiview rendering within a render pass.
VkPhysicalDeviceMultiviewFeatures	multiview(boolean value)	Sets the specified value to the multiview() field.
boolean	multiviewGeometryShader()	specifies whether the implementation supports multiview rendering within a render pass, with geometry shaders.
VkPhysicalDeviceMultiviewFeatures	multiviewGeometryShader(boolean value)	Sets the specified value to the multiviewGeometryShader() field.
boolean	multiviewTessellationShader()	specifies whether the implementation supports multiview rendering within a render pass, with tessellation shaders.
VkPhysicalDeviceMultiviewFeatures	multiviewTessellationShader(boolean value)	Sets the specified value to the multiviewTessellationShader() field.
static int	nmultiview(long struct)	Unsafe version of multiview().
static void	nmultiview(long struct, int value)	Unsafe version of multiview.
static int	nmultiviewGeometryShader(long struct)	Unsafe version of multiviewGeometryShader().
static void	nmultiviewGeometryShader(long struct, int value)	Unsafe version of multiviewGeometryShader.
static int	nmultiviewTessellationShader(long struct)	Unsafe version of multiviewTessellationShader().
static void	nmultiviewTessellationShader(long struct, int value)	Unsafe version of multiviewTessellationShader.
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.
VkPhysicalDeviceMultiviewFeatures	pNext(long value)	Sets the specified value to the pNext() field.
VkPhysicalDeviceMultiviewFeatures	set(int sType, long pNext, boolean multiview, boolean multiviewGeometryShader, boolean multiviewTessellationShader)	Initializes this struct with the specified values.
VkPhysicalDeviceMultiviewFeatures	set(VkPhysicalDeviceMultiviewFeatures src)	Copies the specified struct data to this struct.
int	sizeof()	Returns sizeof(struct).
int	sType()	a VkStructureType value identifying this structure.
VkPhysicalDeviceMultiviewFeatures	sType(int value)	Sets the specified value to the sType() field.
VkPhysicalDeviceMultiviewFeatures	sType$Default()	Sets the STRUCTURE_TYPE_PHYSICAL_DEVICE_MULTIVIEW_FEATURES value to the sType() field.

Methods inherited from class org.lwjgl.system.Struct

clear, free, isNull, 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.

MULTIVIEW

public static final int MULTIVIEW

The struct member offsets.

MULTIVIEWGEOMETRYSHADER

public static final int MULTIVIEWGEOMETRYSHADER

The struct member offsets.

MULTIVIEWTESSELLATIONSHADER

public static final int MULTIVIEWTESSELLATIONSHADER

The struct member offsets.

Constructor Details

VkPhysicalDeviceMultiviewFeatures

public VkPhysicalDeviceMultiviewFeatures(ByteBuffer container)

Creates a VkPhysicalDeviceMultiviewFeatures 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()

Description copied from class: Struct

Returns sizeof(struct).

Specified by:

sizeof in class Struct<VkPhysicalDeviceMultiviewFeatures>

sType

public int sType()

a VkStructureType value identifying this structure.

pNext

public long pNext()

NULL or a pointer to a structure extending this structure.

multiview

public boolean multiview()

specifies whether the implementation supports multiview rendering within a render pass. If this feature is not enabled, the view mask of each subpass must always be zero.

multiviewGeometryShader

public boolean multiviewGeometryShader()

specifies whether the implementation supports multiview rendering within a render pass, with geometry shaders. If this feature is not enabled, then a pipeline compiled against a subpass with a non-zero view mask must not include a geometry shader.

multiviewTessellationShader

public boolean multiviewTessellationShader()

specifies whether the implementation supports multiview rendering within a render pass, with tessellation shaders. If this feature is not enabled, then a pipeline compiled against a subpass with a non-zero view mask must not include any tessellation shaders.

sType

public VkPhysicalDeviceMultiviewFeatures sType(int value)

Sets the specified value to the sType() field.

sType$Default

public VkPhysicalDeviceMultiviewFeatures sType$Default()

Sets the STRUCTURE_TYPE_PHYSICAL_DEVICE_MULTIVIEW_FEATURES value to the sType() field.

pNext

public VkPhysicalDeviceMultiviewFeatures pNext(long value)

Sets the specified value to the pNext() field.

multiview

public VkPhysicalDeviceMultiviewFeatures multiview(boolean value)

Sets the specified value to the multiview() field.

multiviewGeometryShader

public VkPhysicalDeviceMultiviewFeatures multiviewGeometryShader(boolean value)

Sets the specified value to the multiviewGeometryShader() field.

multiviewTessellationShader

public VkPhysicalDeviceMultiviewFeatures multiviewTessellationShader(boolean value)

Sets the specified value to the multiviewTessellationShader() field.

set

public VkPhysicalDeviceMultiviewFeatures set(int sType,
 long pNext,
 boolean multiview,
 boolean multiviewGeometryShader,
 boolean multiviewTessellationShader)

Initializes this struct with the specified values.

set

public VkPhysicalDeviceMultiviewFeatures set(VkPhysicalDeviceMultiviewFeatures src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static VkPhysicalDeviceMultiviewFeatures malloc()

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

calloc

public static VkPhysicalDeviceMultiviewFeatures calloc()

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

create

public static VkPhysicalDeviceMultiviewFeatures create()

Returns a new VkPhysicalDeviceMultiviewFeatures instance allocated with BufferUtils.

create

public static VkPhysicalDeviceMultiviewFeatures create(long address)

Returns a new VkPhysicalDeviceMultiviewFeatures instance for the specified memory address.

createSafe

@Nullable
public static VkPhysicalDeviceMultiviewFeatures createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VkPhysicalDeviceMultiviewFeatures.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static VkPhysicalDeviceMultiviewFeatures.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static VkPhysicalDeviceMultiviewFeatures.Buffer create(int capacity)

Returns a new VkPhysicalDeviceMultiviewFeatures.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a VkPhysicalDeviceMultiviewFeatures.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

mallocStack

@Deprecated
public static VkPhysicalDeviceMultiviewFeatures mallocStack()

Deprecated.

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

callocStack

@Deprecated
public static VkPhysicalDeviceMultiviewFeatures callocStack()

Deprecated.

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

mallocStack

@Deprecated
public static VkPhysicalDeviceMultiviewFeatures mallocStack(MemoryStack stack)

Deprecated.

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

callocStack

@Deprecated
public static VkPhysicalDeviceMultiviewFeatures callocStack(MemoryStack stack)

Deprecated.

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

mallocStack

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

Deprecated.

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

callocStack

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

Deprecated.

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

mallocStack

@Deprecated
public static VkPhysicalDeviceMultiviewFeatures.Buffer mallocStack(int capacity,
 MemoryStack stack)

Deprecated.

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

callocStack

@Deprecated
public static VkPhysicalDeviceMultiviewFeatures.Buffer callocStack(int capacity,
 MemoryStack stack)

Deprecated.

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

malloc

public static VkPhysicalDeviceMultiviewFeatures malloc(MemoryStack stack)

Returns a new VkPhysicalDeviceMultiviewFeatures instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

public static VkPhysicalDeviceMultiviewFeatures calloc(MemoryStack stack)

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

Parameters:

stack - the stack from which to allocate

malloc

public static VkPhysicalDeviceMultiviewFeatures.Buffer malloc(int capacity,
 MemoryStack stack)

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

public static VkPhysicalDeviceMultiviewFeatures.Buffer calloc(int capacity,
 MemoryStack stack)

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

nmultiview

public static int nmultiview(long struct)

Unsafe version of multiview().

nmultiviewGeometryShader

public static int nmultiviewGeometryShader(long struct)

Unsafe version of multiviewGeometryShader().

nmultiviewTessellationShader

public static int nmultiviewTessellationShader(long struct)

Unsafe version of multiviewTessellationShader().

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.

nmultiview

public static void nmultiview(long struct,
 int value)

Unsafe version of multiview.

nmultiviewGeometryShader

public static void nmultiviewGeometryShader(long struct,
 int value)

Unsafe version of multiviewGeometryShader.

nmultiviewTessellationShader

public static void nmultiviewTessellationShader(long struct,
 int value)

Unsafe version of multiviewTessellationShader.