Top Description Inners Fields Constructors Methods
org.lwjgl.vulkan

public Class VkPhysicalDeviceVideoFormatInfoKHR

extends Struct<VkPhysicalDeviceVideoFormatInfoKHR>
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 specifying the codec video format.
Valid Usage (Implicit)
See Also

GetPhysicalDeviceVideoFormatPropertiesKHR

Layout


struct VkPhysicalDeviceVideoFormatInfoKHR {
    VkStructureType sType;
    void const * pNext;
    VkImageUsageFlags imageUsage;
}

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
IMAGEUSAGE

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

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

Method Summary

Modifier and TypeMethod and Description
public static VkPhysicalDeviceVideoFormatInfoKHR
calloc()

Returns a new VkPhysicalDeviceVideoFormatInfoKHR instance allocated with memCalloc.

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

Returns a new VkPhysicalDeviceVideoFormatInfoKHR.Buffer instance allocated with memCalloc.

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

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

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

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

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

Returns a new VkPhysicalDeviceVideoFormatInfoKHR instance allocated with BufferUtils.

public static VkPhysicalDeviceVideoFormatInfoKHR
create(long address)

Returns a new VkPhysicalDeviceVideoFormatInfoKHR instance for the specified memory address.

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

Returns a new VkPhysicalDeviceVideoFormatInfoKHR.Buffer instance allocated with BufferUtils.

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

Create a VkPhysicalDeviceVideoFormatInfoKHR.Buffer instance at the specified memory.

public static VkPhysicalDeviceVideoFormatInfoKHR
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public int
imageUsage()

a bitmask of VkImageUsageFlagBits specifying the intended usage of the video images.

public VkPhysicalDeviceVideoFormatInfoKHR
imageUsage(int value)

Sets the specified value to the imageUsage field.

public static VkPhysicalDeviceVideoFormatInfoKHR
malloc()

Returns a new VkPhysicalDeviceVideoFormatInfoKHR instance allocated with memAlloc.

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

Returns a new VkPhysicalDeviceVideoFormatInfoKHR.Buffer instance allocated with memAlloc.

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

Returns a new VkPhysicalDeviceVideoFormatInfoKHR instance allocated on the specified MemoryStack.

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

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

public static int
nimageUsage(long struct)

Unsafe version of imageUsage.

public static void
nimageUsage(long struct, int value)

Unsafe version of imageUsage.

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

Sets the specified value to the pNext field.

public VkPhysicalDeviceVideoFormatInfoKHR
pNext(VkVideoProfileListInfoKHR value)

Prepends the specified VkVideoProfileListInfoKHR value to the pNext chain.

public VkPhysicalDeviceVideoFormatInfoKHR
set(int sType, long pNext, int imageUsage)

Initializes this struct with the specified values.

public VkPhysicalDeviceVideoFormatInfoKHR

Returns:

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

Sets the specified value to the sType field.

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

IMAGEUSAGEback to summary
public static final int IMAGEUSAGE

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

VkPhysicalDeviceVideoFormatInfoKHRback to summary
protected VkPhysicalDeviceVideoFormatInfoKHR(long address, ByteBuffer container)
VkPhysicalDeviceVideoFormatInfoKHRback to summary
public VkPhysicalDeviceVideoFormatInfoKHR(ByteBuffer container)

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

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

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

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static VkPhysicalDeviceVideoFormatInfoKHR calloc(MemoryStack stack)

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

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

Returns a new VkPhysicalDeviceVideoFormatInfoKHR instance allocated with BufferUtils.

createback to summary
public static VkPhysicalDeviceVideoFormatInfoKHR create(long address)

Returns a new VkPhysicalDeviceVideoFormatInfoKHR instance for the specified memory address.

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

Returns a new VkPhysicalDeviceVideoFormatInfoKHR.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a VkPhysicalDeviceVideoFormatInfoKHR.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static VkPhysicalDeviceVideoFormatInfoKHR createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

Annotations
@Nullable
imageUsageback to summary
public int imageUsage()

a bitmask of VkImageUsageFlagBits specifying the intended usage of the video images.

Annotations
@NativeType:VkImageUsageFlags
imageUsageback to summary
public VkPhysicalDeviceVideoFormatInfoKHR imageUsage(int value)

Sets the specified value to the imageUsage field.

mallocback to summary
public static VkPhysicalDeviceVideoFormatInfoKHR malloc()

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

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

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static VkPhysicalDeviceVideoFormatInfoKHR malloc(MemoryStack stack)

Returns a new VkPhysicalDeviceVideoFormatInfoKHR instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

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

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

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

nimageUsageback to summary
public static int nimageUsage(long struct)

Unsafe version of imageUsage.

nimageUsageback to summary
public static void nimageUsage(long struct, int value)

Unsafe version of imageUsage.

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 const *
pNextback to summary
public VkPhysicalDeviceVideoFormatInfoKHR pNext(long value)

Sets the specified value to the pNext field.

pNextback to summary
public VkPhysicalDeviceVideoFormatInfoKHR pNext(VkVideoProfileListInfoKHR value)

Prepends the specified VkVideoProfileListInfoKHR value to the pNext chain.

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

Initializes this struct with the specified values.

setback to summary
public VkPhysicalDeviceVideoFormatInfoKHR set(VkPhysicalDeviceVideoFormatInfoKHR src)

Copies the specified struct data to this struct.

Parameters
src:VkPhysicalDeviceVideoFormatInfoKHR

the source struct

Returns:VkPhysicalDeviceVideoFormatInfoKHR

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

Sets the specified value to the sType field.

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

Sets the STRUCTURE_TYPE_PHYSICAL_DEVICE_VIDEO_FORMAT_INFO_KHR value to the sType field.

org.lwjgl.vulkan back to summary

public Class VkPhysicalDeviceVideoFormatInfoKHR.Buffer

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

An array of VkPhysicalDeviceVideoFormatInfoKHR structs.

Field Summary

Modifier and TypeField and Description
private static final VkPhysicalDeviceVideoFormatInfoKHR

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new VkPhysicalDeviceVideoFormatInfoKHR.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 VkPhysicalDeviceVideoFormatInfoKHR
public int
public VkPhysicalDeviceVideoFormatInfoKHR.Buffer
imageUsage(int value)

Sets the specified value to the VkPhysicalDeviceVideoFormatInfoKHR#imageUsage field.

public long

Returns:

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

public VkPhysicalDeviceVideoFormatInfoKHR.Buffer
pNext(long value)

Sets the specified value to the VkPhysicalDeviceVideoFormatInfoKHR#pNext field.

public VkPhysicalDeviceVideoFormatInfoKHR.Buffer
pNext(VkVideoProfileListInfoKHR value)

Prepends the specified VkVideoProfileListInfoKHR value to the pNext chain.

protected VkPhysicalDeviceVideoFormatInfoKHR.Buffer
public int

Returns:

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

public VkPhysicalDeviceVideoFormatInfoKHR.Buffer
sType(int value)

Sets the specified value to the VkPhysicalDeviceVideoFormatInfoKHR#sType field.

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

Field Detail

ELEMENT_FACTORYback to summary
private static final VkPhysicalDeviceVideoFormatInfoKHR ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

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

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

Annotations
@Override
imageUsageback to summary
public int imageUsage()
Returns:int

the value of the VkPhysicalDeviceVideoFormatInfoKHR#imageUsage field.

Annotations
@NativeType:VkImageUsageFlags
imageUsageback to summary
public VkPhysicalDeviceVideoFormatInfoKHR.Buffer imageUsage(int value)

Sets the specified value to the VkPhysicalDeviceVideoFormatInfoKHR#imageUsage field.

pNextback to summary
public long pNext()
Returns:long

the value of the VkPhysicalDeviceVideoFormatInfoKHR#pNext field.

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

Sets the specified value to the VkPhysicalDeviceVideoFormatInfoKHR#pNext field.

pNextback to summary
public VkPhysicalDeviceVideoFormatInfoKHR.Buffer pNext(VkVideoProfileListInfoKHR value)

Prepends the specified VkVideoProfileListInfoKHR value to the pNext chain.

selfback to summary
protected VkPhysicalDeviceVideoFormatInfoKHR.Buffer self()

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

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

the value of the VkPhysicalDeviceVideoFormatInfoKHR#sType field.

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

Sets the specified value to the VkPhysicalDeviceVideoFormatInfoKHR#sType field.

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

Sets the STRUCTURE_TYPE_PHYSICAL_DEVICE_VIDEO_FORMAT_INFO_KHR value to the VkPhysicalDeviceVideoFormatInfoKHR#sType field.