Top Description Inners Fields Constructors Methods
org.lwjgl.vulkan

public Class VkPhysicalDeviceOpticalFlowFeaturesNV

extends Struct<VkPhysicalDeviceOpticalFlowFeaturesNV>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable
Imports
javax.annotation.*, java.nio.*, org.lwjgl.*, org.lwjgl.system.*

Structure describing the optical flow features supported by the implementation.
Description

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

Valid Usage (Implicit)

Layout


struct VkPhysicalDeviceOpticalFlowFeaturesNV {
    VkStructureType sType;
    void * pNext;
    VkBool32 opticalFlow;
}

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
OPTICALFLOW

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

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

Method Summary

Modifier and TypeMethod and Description
public static VkPhysicalDeviceOpticalFlowFeaturesNV
calloc()

Returns a new VkPhysicalDeviceOpticalFlowFeaturesNV instance allocated with memCalloc.

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

Returns a new VkPhysicalDeviceOpticalFlowFeaturesNV.Buffer instance allocated with memCalloc.

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

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

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

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

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

Returns a new VkPhysicalDeviceOpticalFlowFeaturesNV instance allocated with BufferUtils.

public static VkPhysicalDeviceOpticalFlowFeaturesNV
create(long address)

Returns a new VkPhysicalDeviceOpticalFlowFeaturesNV instance for the specified memory address.

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

Returns a new VkPhysicalDeviceOpticalFlowFeaturesNV.Buffer instance allocated with BufferUtils.

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

Create a VkPhysicalDeviceOpticalFlowFeaturesNV.Buffer instance at the specified memory.

public static VkPhysicalDeviceOpticalFlowFeaturesNV
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public static VkPhysicalDeviceOpticalFlowFeaturesNV
malloc()

Returns a new VkPhysicalDeviceOpticalFlowFeaturesNV instance allocated with memAlloc.

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

Returns a new VkPhysicalDeviceOpticalFlowFeaturesNV.Buffer instance allocated with memAlloc.

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

Returns a new VkPhysicalDeviceOpticalFlowFeaturesNV instance allocated on the specified MemoryStack.

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

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

public static int
nopticalFlow(long struct)

Unsafe version of opticalFlow.

public static void
nopticalFlow(long struct, int value)

Unsafe version of opticalFlow.

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 boolean
opticalFlow()

indicates whether the implementation supports optical flow.

public VkPhysicalDeviceOpticalFlowFeaturesNV
opticalFlow(boolean value)

Sets the specified value to the opticalFlow field.

public long
pNext()

NULL or a pointer to a structure extending this structure.

public VkPhysicalDeviceOpticalFlowFeaturesNV
pNext(long value)

Sets the specified value to the pNext field.

public VkPhysicalDeviceOpticalFlowFeaturesNV
set(int sType, long pNext, boolean opticalFlow)

Initializes this struct with the specified values.

public VkPhysicalDeviceOpticalFlowFeaturesNV

Returns:

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

Sets the specified value to the sType field.

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

OPTICALFLOWback to summary
public static final int OPTICALFLOW

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

VkPhysicalDeviceOpticalFlowFeaturesNVback to summary
protected VkPhysicalDeviceOpticalFlowFeaturesNV(long address, ByteBuffer container)
VkPhysicalDeviceOpticalFlowFeaturesNVback to summary
public VkPhysicalDeviceOpticalFlowFeaturesNV(ByteBuffer container)

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

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

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

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static VkPhysicalDeviceOpticalFlowFeaturesNV calloc(MemoryStack stack)

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

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

Returns a new VkPhysicalDeviceOpticalFlowFeaturesNV instance allocated with BufferUtils.

createback to summary
public static VkPhysicalDeviceOpticalFlowFeaturesNV create(long address)

Returns a new VkPhysicalDeviceOpticalFlowFeaturesNV instance for the specified memory address.

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

Returns a new VkPhysicalDeviceOpticalFlowFeaturesNV.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a VkPhysicalDeviceOpticalFlowFeaturesNV.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static VkPhysicalDeviceOpticalFlowFeaturesNV createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

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

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

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

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static VkPhysicalDeviceOpticalFlowFeaturesNV malloc(MemoryStack stack)

Returns a new VkPhysicalDeviceOpticalFlowFeaturesNV instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

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

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

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

nopticalFlowback to summary
public static int nopticalFlow(long struct)

Unsafe version of opticalFlow.

nopticalFlowback to summary
public static void nopticalFlow(long struct, int value)

Unsafe version of opticalFlow.

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.

opticalFlowback to summary
public boolean opticalFlow()

indicates whether the implementation supports optical flow.

Annotations
@NativeType:VkBool32
opticalFlowback to summary
public VkPhysicalDeviceOpticalFlowFeaturesNV opticalFlow(boolean value)

Sets the specified value to the opticalFlow field.

pNextback to summary
public long pNext()

NULL or a pointer to a structure extending this structure.

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

Sets the specified value to the pNext field.

setback to summary
public VkPhysicalDeviceOpticalFlowFeaturesNV set(int sType, long pNext, boolean opticalFlow)

Initializes this struct with the specified values.

setback to summary
public VkPhysicalDeviceOpticalFlowFeaturesNV set(VkPhysicalDeviceOpticalFlowFeaturesNV src)

Copies the specified struct data to this struct.

Parameters
src:VkPhysicalDeviceOpticalFlowFeaturesNV

the source struct

Returns:VkPhysicalDeviceOpticalFlowFeaturesNV

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

Sets the specified value to the sType field.

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

Sets the STRUCTURE_TYPE_PHYSICAL_DEVICE_OPTICAL_FLOW_FEATURES_NV value to the sType field.

org.lwjgl.vulkan back to summary

public Class VkPhysicalDeviceOpticalFlowFeaturesNV.Buffer

extends StructBuffer<VkPhysicalDeviceOpticalFlowFeaturesNV, VkPhysicalDeviceOpticalFlowFeaturesNV.Buffer>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable

An array of VkPhysicalDeviceOpticalFlowFeaturesNV structs.

Field Summary

Modifier and TypeField and Description
private static final VkPhysicalDeviceOpticalFlowFeaturesNV

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new VkPhysicalDeviceOpticalFlowFeaturesNV.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 VkPhysicalDeviceOpticalFlowFeaturesNV
public boolean
public VkPhysicalDeviceOpticalFlowFeaturesNV.Buffer
opticalFlow(boolean value)

Sets the specified value to the VkPhysicalDeviceOpticalFlowFeaturesNV#opticalFlow field.

public long

Returns:

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

public VkPhysicalDeviceOpticalFlowFeaturesNV.Buffer
pNext(long value)

Sets the specified value to the VkPhysicalDeviceOpticalFlowFeaturesNV#pNext field.

protected VkPhysicalDeviceOpticalFlowFeaturesNV.Buffer
public int

Returns:

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

public VkPhysicalDeviceOpticalFlowFeaturesNV.Buffer
sType(int value)

Sets the specified value to the VkPhysicalDeviceOpticalFlowFeaturesNV#sType field.

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

Field Detail

ELEMENT_FACTORYback to summary
private static final VkPhysicalDeviceOpticalFlowFeaturesNV ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

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

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

Annotations
@Override
opticalFlowback to summary
public boolean opticalFlow()
Returns:boolean

the value of the VkPhysicalDeviceOpticalFlowFeaturesNV#opticalFlow field.

Annotations
@NativeType:VkBool32
opticalFlowback to summary
public VkPhysicalDeviceOpticalFlowFeaturesNV.Buffer opticalFlow(boolean value)

Sets the specified value to the VkPhysicalDeviceOpticalFlowFeaturesNV#opticalFlow field.

pNextback to summary
public long pNext()
Returns:long

the value of the VkPhysicalDeviceOpticalFlowFeaturesNV#pNext field.

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

Sets the specified value to the VkPhysicalDeviceOpticalFlowFeaturesNV#pNext field.

selfback to summary
protected VkPhysicalDeviceOpticalFlowFeaturesNV.Buffer self()

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

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

the value of the VkPhysicalDeviceOpticalFlowFeaturesNV#sType field.

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

Sets the specified value to the VkPhysicalDeviceOpticalFlowFeaturesNV#sType field.

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

Sets the STRUCTURE_TYPE_PHYSICAL_DEVICE_OPTICAL_FLOW_FEATURES_NV value to the VkPhysicalDeviceOpticalFlowFeaturesNV#sType field.