Top Description Inners Fields Constructors Methods
org.lwjgl.vulkan

public Class VkPhysicalDeviceShaderTerminateInvocationFeatures

extends Struct<VkPhysicalDeviceShaderTerminateInvocationFeatures>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable
Known Direct Subclasses
org.lwjgl.vulkan.VkPhysicalDeviceShaderTerminateInvocationFeaturesKHR
Imports
javax.annotation.*, java.nio.*, org.lwjgl.*, org.lwjgl.system.*

Structure describing support for the SPIR-V SPV_KHR_terminate_invocation extension.
Description

If the VkPhysicalDeviceShaderTerminateInvocationFeatures 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. VkPhysicalDeviceShaderTerminateInvocationFeatures can also be used in the pNext chain of VkDeviceCreateInfo to selectively enable these features.

Valid Usage (Implicit)

Layout


struct VkPhysicalDeviceShaderTerminateInvocationFeatures {
    VkStructureType sType;
    void * pNext;
    VkBool32 shaderTerminateInvocation;
}

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class

Field Summary

Modifier and TypeField and Description
public static final int
ALIGNOF

The struct alignment in bytes.

public static final int
PNEXT

The struct member offsets.

public static final int
SHADERTERMINATEINVOCATION

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
public
VkPhysicalDeviceShaderTerminateInvocationFeatures(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public static VkPhysicalDeviceShaderTerminateInvocationFeatures
calloc()

Returns a new VkPhysicalDeviceShaderTerminateInvocationFeatures instance allocated with memCalloc.

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

Returns a new VkPhysicalDeviceShaderTerminateInvocationFeatures.Buffer instance allocated with memCalloc.

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

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

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

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

protected VkPhysicalDeviceShaderTerminateInvocationFeatures
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 VkPhysicalDeviceShaderTerminateInvocationFeatures
create()

Returns a new VkPhysicalDeviceShaderTerminateInvocationFeatures instance allocated with BufferUtils.

public static VkPhysicalDeviceShaderTerminateInvocationFeatures
create(long address)

Returns a new VkPhysicalDeviceShaderTerminateInvocationFeatures instance for the specified memory address.

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

Returns a new VkPhysicalDeviceShaderTerminateInvocationFeatures.Buffer instance allocated with BufferUtils.

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

Create a VkPhysicalDeviceShaderTerminateInvocationFeatures.Buffer instance at the specified memory.

public static VkPhysicalDeviceShaderTerminateInvocationFeatures
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public static VkPhysicalDeviceShaderTerminateInvocationFeatures
malloc()

Returns a new VkPhysicalDeviceShaderTerminateInvocationFeatures instance allocated with memAlloc.

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

Returns a new VkPhysicalDeviceShaderTerminateInvocationFeatures.Buffer instance allocated with memAlloc.

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

Returns a new VkPhysicalDeviceShaderTerminateInvocationFeatures instance allocated on the specified MemoryStack.

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

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

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
public static void
nshaderTerminateInvocation(long struct, int value)

Unsafe version of shaderTerminateInvocation.

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

Sets the specified value to the pNext field.

public VkPhysicalDeviceShaderTerminateInvocationFeatures
set(int sType, long pNext, boolean shaderTerminateInvocation)

Initializes this struct with the specified values.

public VkPhysicalDeviceShaderTerminateInvocationFeatures

Returns:

this struct
set
(VkPhysicalDeviceShaderTerminateInvocationFeatures
the source struct
src
)

Copies the specified struct data to this struct.

public boolean
shaderTerminateInvocation()

specifies whether the implementation supports SPIR-V modules that use the SPV_KHR_terminate_invocation extension.

public VkPhysicalDeviceShaderTerminateInvocationFeatures
shaderTerminateInvocation(boolean value)

Sets the specified value to the shaderTerminateInvocation field.

public int
sizeof()

Implements abstract org.lwjgl.system.Struct.sizeof.

Returns sizeof(struct).
public int
sType()

a VkStructureType value identifying this structure.

public VkPhysicalDeviceShaderTerminateInvocationFeatures
sType(int value)

Sets the specified value to the sType field.

public VkPhysicalDeviceShaderTerminateInvocationFeatures
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.

PNEXTback to summary
public static final int PNEXT

The struct member offsets.

SHADERTERMINATEINVOCATIONback to summary
public static final int SHADERTERMINATEINVOCATION

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

VkPhysicalDeviceShaderTerminateInvocationFeaturesback to summary
protected VkPhysicalDeviceShaderTerminateInvocationFeatures(long address, ByteBuffer container)
VkPhysicalDeviceShaderTerminateInvocationFeaturesback to summary
public VkPhysicalDeviceShaderTerminateInvocationFeatures(ByteBuffer container)

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

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

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

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static VkPhysicalDeviceShaderTerminateInvocationFeatures calloc(MemoryStack stack)

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

Returns a new VkPhysicalDeviceShaderTerminateInvocationFeatures.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

createback to summary
protected VkPhysicalDeviceShaderTerminateInvocationFeatures 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 VkPhysicalDeviceShaderTerminateInvocationFeatures create()

Returns a new VkPhysicalDeviceShaderTerminateInvocationFeatures instance allocated with BufferUtils.

createback to summary
public static VkPhysicalDeviceShaderTerminateInvocationFeatures create(long address)

Returns a new VkPhysicalDeviceShaderTerminateInvocationFeatures instance for the specified memory address.

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

Returns a new VkPhysicalDeviceShaderTerminateInvocationFeatures.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a VkPhysicalDeviceShaderTerminateInvocationFeatures.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static VkPhysicalDeviceShaderTerminateInvocationFeatures createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

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

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

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

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static VkPhysicalDeviceShaderTerminateInvocationFeatures malloc(MemoryStack stack)

Returns a new VkPhysicalDeviceShaderTerminateInvocationFeatures instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

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

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

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

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.

nshaderTerminateInvocationback to summary
public static int nshaderTerminateInvocation(long struct)

Unsafe version of shaderTerminateInvocation.

nshaderTerminateInvocationback to summary
public static void nshaderTerminateInvocation(long struct, int value)

Unsafe version of shaderTerminateInvocation.

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

Sets the specified value to the pNext field.

setback to summary
public VkPhysicalDeviceShaderTerminateInvocationFeatures set(int sType, long pNext, boolean shaderTerminateInvocation)

Initializes this struct with the specified values.

setback to summary
public VkPhysicalDeviceShaderTerminateInvocationFeatures set(VkPhysicalDeviceShaderTerminateInvocationFeatures src)

Copies the specified struct data to this struct.

Parameters
src:VkPhysicalDeviceShaderTerminateInvocationFeatures

the source struct

Returns:VkPhysicalDeviceShaderTerminateInvocationFeatures

this struct

shaderTerminateInvocationback to summary
public boolean shaderTerminateInvocation()

specifies whether the implementation supports SPIR-V modules that use the SPV_KHR_terminate_invocation extension.

Annotations
@NativeType:VkBool32
shaderTerminateInvocationback to summary
public VkPhysicalDeviceShaderTerminateInvocationFeatures shaderTerminateInvocation(boolean value)

Sets the specified value to the shaderTerminateInvocation field.

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

Sets the specified value to the sType field.

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

Sets the STRUCTURE_TYPE_PHYSICAL_DEVICE_SHADER_TERMINATE_INVOCATION_FEATURES value to the sType field.

org.lwjgl.vulkan back to summary

public Class VkPhysicalDeviceShaderTerminateInvocationFeatures.Buffer

extends StructBuffer<VkPhysicalDeviceShaderTerminateInvocationFeatures, VkPhysicalDeviceShaderTerminateInvocationFeatures.Buffer>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable
Known Direct Subclasses
org.lwjgl.vulkan.VkPhysicalDeviceShaderTerminateInvocationFeaturesKHR.Buffer

An array of VkPhysicalDeviceShaderTerminateInvocationFeatures structs.

Field Summary

Modifier and TypeField and Description
private static final VkPhysicalDeviceShaderTerminateInvocationFeatures

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new VkPhysicalDeviceShaderTerminateInvocationFeatures.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 VkPhysicalDeviceShaderTerminateInvocationFeatures
public long
public VkPhysicalDeviceShaderTerminateInvocationFeatures.Buffer
pNext(long value)

Sets the specified value to the VkPhysicalDeviceShaderTerminateInvocationFeatures#pNext field.

protected VkPhysicalDeviceShaderTerminateInvocationFeatures.Buffer
public boolean
public VkPhysicalDeviceShaderTerminateInvocationFeatures.Buffer
public int
public VkPhysicalDeviceShaderTerminateInvocationFeatures.Buffer
sType(int value)

Sets the specified value to the VkPhysicalDeviceShaderTerminateInvocationFeatures#sType field.

public VkPhysicalDeviceShaderTerminateInvocationFeatures.Buffer
Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final VkPhysicalDeviceShaderTerminateInvocationFeatures ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

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

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

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

the value of the VkPhysicalDeviceShaderTerminateInvocationFeatures#pNext field.

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

Sets the specified value to the VkPhysicalDeviceShaderTerminateInvocationFeatures#pNext field.

selfback to summary
protected VkPhysicalDeviceShaderTerminateInvocationFeatures.Buffer self()

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

Annotations
@Override
shaderTerminateInvocationback to summary
public boolean shaderTerminateInvocation()
Returns:boolean

the value of the VkPhysicalDeviceShaderTerminateInvocationFeatures#shaderTerminateInvocation field.

Annotations
@NativeType:VkBool32
shaderTerminateInvocationback to summary
public VkPhysicalDeviceShaderTerminateInvocationFeatures.Buffer shaderTerminateInvocation(boolean value)

Sets the specified value to the VkPhysicalDeviceShaderTerminateInvocationFeatures#shaderTerminateInvocation field.

sTypeback to summary
public int sType()
Returns:int

the value of the VkPhysicalDeviceShaderTerminateInvocationFeatures#sType field.

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

Sets the specified value to the VkPhysicalDeviceShaderTerminateInvocationFeatures#sType field.

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

Sets the STRUCTURE_TYPE_PHYSICAL_DEVICE_SHADER_TERMINATE_INVOCATION_FEATURES value to the VkPhysicalDeviceShaderTerminateInvocationFeatures#sType field.