Top Description Inners Fields Constructors Methods
org.lwjgl.vulkan

public Class VkPhysicalDeviceMultiviewProperties

extends Struct<VkPhysicalDeviceMultiviewProperties>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable
Known Direct Subclasses
org.lwjgl.vulkan.VkPhysicalDeviceMultiviewPropertiesKHR
Imports
javax.annotation.*, java.nio.*, org.lwjgl.*, org.lwjgl.system.*
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)

Layout


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

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class
VkPhysicalDeviceMultiviewProperties.Buffer

An array of VkPhysicalDeviceMultiviewProperties structs.

Field Summary

Modifier and TypeField and Description
public static final int
ALIGNOF

The struct alignment in bytes.

public static final int
MAXMULTIVIEWINSTANCEINDEX

The struct member offsets.

public static final int
MAXMULTIVIEWVIEWCOUNT

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

public
VkPhysicalDeviceMultiviewProperties(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public static VkPhysicalDeviceMultiviewProperties
calloc()

Returns a new VkPhysicalDeviceMultiviewProperties instance allocated with memCalloc.

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

Returns a new VkPhysicalDeviceMultiviewProperties.Buffer instance allocated with memCalloc.

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

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

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

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

public static VkPhysicalDeviceMultiviewProperties
callocStack()

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

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

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

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

Returns a new VkPhysicalDeviceMultiviewProperties instance allocated with BufferUtils.

public static VkPhysicalDeviceMultiviewProperties
create(long address)

Returns a new VkPhysicalDeviceMultiviewProperties instance for the specified memory address.

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

Returns a new VkPhysicalDeviceMultiviewProperties.Buffer instance allocated with BufferUtils.

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

Create a VkPhysicalDeviceMultiviewProperties.Buffer instance at the specified memory.

public static VkPhysicalDeviceMultiviewProperties
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public static VkPhysicalDeviceMultiviewProperties
malloc()

Returns a new VkPhysicalDeviceMultiviewProperties instance allocated with memAlloc.

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

Returns a new VkPhysicalDeviceMultiviewProperties.Buffer instance allocated with memAlloc.

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

Returns a new VkPhysicalDeviceMultiviewProperties instance allocated on the specified MemoryStack.

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

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

public static VkPhysicalDeviceMultiviewProperties
mallocStack()

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

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

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

Deprecated
Deprecated for removal in 3.4.0.
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.

public int
maxMultiviewViewCount()

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

public static int
nmaxMultiviewInstanceIndex(long struct)

Unsafe version of maxMultiviewInstanceIndex.

public static int
nmaxMultiviewViewCount(long struct)

Unsafe version of maxMultiviewViewCount.

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 long
pNext()

NULL or a pointer to a structure extending this structure.

public VkPhysicalDeviceMultiviewProperties
pNext(long value)

Sets the specified value to the pNext field.

public VkPhysicalDeviceMultiviewProperties
set(int sType, long pNext)

Initializes this struct with the specified values.

public VkPhysicalDeviceMultiviewProperties

Returns:

this struct
set(VkPhysicalDeviceMultiviewProperties
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 VkPhysicalDeviceMultiviewProperties
sType(int value)

Sets the specified value to the sType field.

public VkPhysicalDeviceMultiviewProperties
sType$Default()

Sets the STRUCTURE_TYPE_PHYSICAL_DEVICE_MULTIVIEW_PROPERTIES 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.

MAXMULTIVIEWINSTANCEINDEXback to summary
public static final int MAXMULTIVIEWINSTANCEINDEX

The struct member offsets.

MAXMULTIVIEWVIEWCOUNTback to summary
public static final int MAXMULTIVIEWVIEWCOUNT

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

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

callocback to summary
public static VkPhysicalDeviceMultiviewProperties calloc()

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

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

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static VkPhysicalDeviceMultiviewProperties calloc(MemoryStack stack)

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

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

Deprecated

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

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

Deprecated

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

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

Deprecated

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

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

Returns a new VkPhysicalDeviceMultiviewProperties instance allocated with BufferUtils.

createback to summary
public static VkPhysicalDeviceMultiviewProperties create(long address)

Returns a new VkPhysicalDeviceMultiviewProperties instance for the specified memory address.

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

Returns a new VkPhysicalDeviceMultiviewProperties.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a VkPhysicalDeviceMultiviewProperties.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static VkPhysicalDeviceMultiviewProperties createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

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

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

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

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static VkPhysicalDeviceMultiviewProperties malloc(MemoryStack stack)

Returns a new VkPhysicalDeviceMultiviewProperties instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

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

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

Deprecated

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

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

Deprecated

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

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

Deprecated

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

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

Deprecated

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

Annotations
@Deprecated
maxMultiviewInstanceIndexback to summary
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.

Annotations
@NativeType:uint32_t
maxMultiviewViewCountback to summary
public int maxMultiviewViewCount()

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

Annotations
@NativeType:uint32_t
nmaxMultiviewInstanceIndexback to summary
public static int nmaxMultiviewInstanceIndex(long struct)

Unsafe version of maxMultiviewInstanceIndex.

nmaxMultiviewViewCountback to summary
public static int nmaxMultiviewViewCount(long struct)

Unsafe version of maxMultiviewViewCount.

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.

pNextback to summary
public long pNext()

NULL or a pointer to a structure extending this structure.

Annotations
@NativeType:void *
pNextback to summary
public VkPhysicalDeviceMultiviewProperties pNext(long value)

Sets the specified value to the pNext field.

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

Initializes this struct with the specified values.

setback to summary
public VkPhysicalDeviceMultiviewProperties set(VkPhysicalDeviceMultiviewProperties src)

Copies the specified struct data to this struct.

Parameters
src:VkPhysicalDeviceMultiviewProperties

the source struct

Returns:VkPhysicalDeviceMultiviewProperties

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

Sets the specified value to the sType field.

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

Sets the STRUCTURE_TYPE_PHYSICAL_DEVICE_MULTIVIEW_PROPERTIES value to the sType field.

org.lwjgl.vulkan back to summary

public Class VkPhysicalDeviceMultiviewProperties.Buffer

extends StructBuffer<VkPhysicalDeviceMultiviewProperties, VkPhysicalDeviceMultiviewProperties.Buffer>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable
Known Direct Subclasses
org.lwjgl.vulkan.VkPhysicalDeviceMultiviewPropertiesKHR.Buffer
An array of VkPhysicalDeviceMultiviewProperties structs.

Field Summary

Modifier and TypeField and Description
private static final VkPhysicalDeviceMultiviewProperties
ELEMENT_FACTORY

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

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

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

public int

Returns:

the value of the VkPhysicalDeviceMultiviewProperties#maxMultiviewInstanceIndex field.
maxMultiviewInstanceIndex()

public int

Returns:

the value of the VkPhysicalDeviceMultiviewProperties#maxMultiviewViewCount field.
maxMultiviewViewCount()

public long

Returns:

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

public VkPhysicalDeviceMultiviewProperties.Buffer
pNext(long value)

Sets the specified value to the VkPhysicalDeviceMultiviewProperties#pNext field.

protected VkPhysicalDeviceMultiviewProperties.Buffer
self()

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

public int

Returns:

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

public VkPhysicalDeviceMultiviewProperties.Buffer
sType(int value)

Sets the specified value to the VkPhysicalDeviceMultiviewProperties#sType field.

public VkPhysicalDeviceMultiviewProperties.Buffer
sType$Default()

Sets the STRUCTURE_TYPE_PHYSICAL_DEVICE_MULTIVIEW_PROPERTIES value to the VkPhysicalDeviceMultiviewProperties#sType field.

Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final VkPhysicalDeviceMultiviewProperties ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

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

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

Annotations
@Override
maxMultiviewInstanceIndexback to summary
public int maxMultiviewInstanceIndex()
Returns:int

the value of the VkPhysicalDeviceMultiviewProperties#maxMultiviewInstanceIndex field.

Annotations
@NativeType:uint32_t
maxMultiviewViewCountback to summary
public int maxMultiviewViewCount()
Returns:int

the value of the VkPhysicalDeviceMultiviewProperties#maxMultiviewViewCount field.

Annotations
@NativeType:uint32_t
pNextback to summary
public long pNext()
Returns:long

the value of the VkPhysicalDeviceMultiviewProperties#pNext field.

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

Sets the specified value to the VkPhysicalDeviceMultiviewProperties#pNext field.

selfback to summary
protected VkPhysicalDeviceMultiviewProperties.Buffer self()

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

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

the value of the VkPhysicalDeviceMultiviewProperties#sType field.

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

Sets the specified value to the VkPhysicalDeviceMultiviewProperties#sType field.

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

Sets the STRUCTURE_TYPE_PHYSICAL_DEVICE_MULTIVIEW_PROPERTIES value to the VkPhysicalDeviceMultiviewProperties#sType field.