Top Description Inners Fields Constructors Methods
org.lwjgl.vulkan

public Class VkVideoFormatPropertiesKHR

extends Struct<VkVideoFormatPropertiesKHR>
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 enumerating the video image formats.
Valid Usage (Implicit)
See Also

VkComponentMapping, GetPhysicalDeviceVideoFormatPropertiesKHR

Layout


struct VkVideoFormatPropertiesKHR {
    VkStructureType sType;
    void * pNext;
    VkFormat format;
    VkComponentMapping componentMapping;
    VkImageCreateFlags imageCreateFlags;
    VkImageType imageType;
    VkImageTiling imageTiling;
    VkImageUsageFlags imageUsageFlags;
}

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class
VkVideoFormatPropertiesKHR.Buffer

An array of VkVideoFormatPropertiesKHR structs.

Field Summary

Modifier and TypeField and Description
public static final int
ALIGNOF

The struct alignment in bytes.

public static final int
COMPONENTMAPPING

The struct member offsets.

public static final int
FORMAT

The struct member offsets.

public static final int
IMAGECREATEFLAGS

The struct member offsets.

public static final int
IMAGETILING

The struct member offsets.

public static final int
IMAGETYPE

The struct member offsets.

public static final int
IMAGEUSAGEFLAGS

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

public
VkVideoFormatPropertiesKHR(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public static VkVideoFormatPropertiesKHR
calloc()

Returns a new VkVideoFormatPropertiesKHR instance allocated with memCalloc.

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

Returns a new VkVideoFormatPropertiesKHR.Buffer instance allocated with memCalloc.

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

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

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

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

public VkComponentMapping
componentMapping()

defines the color channel order used for the format.

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

Returns a new VkVideoFormatPropertiesKHR instance allocated with BufferUtils.

public static VkVideoFormatPropertiesKHR
create(long address)

Returns a new VkVideoFormatPropertiesKHR instance for the specified memory address.

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

Returns a new VkVideoFormatPropertiesKHR.Buffer instance allocated with BufferUtils.

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

Create a VkVideoFormatPropertiesKHR.Buffer instance at the specified memory.

public static VkVideoFormatPropertiesKHR
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public int
format()

a VkFormat that specifies the format that can be used with the specified video profiles and image usages.

public int
imageCreateFlags()

a bitmask of VkImageCreateFlagBits specifying the supported image creation flags for the format.

public int
imageTiling()

a VkImageTiling that specifies the image tiling the format can be used with.

public int
imageType()

a VkImageType that specifies the image type the format can be used with.

public int
imageUsageFlags()

a bitmask of VkImageUsageFlagBits specifying the supported image usage flags for the format.

public static VkVideoFormatPropertiesKHR
malloc()

Returns a new VkVideoFormatPropertiesKHR instance allocated with memAlloc.

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

Returns a new VkVideoFormatPropertiesKHR.Buffer instance allocated with memAlloc.

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

Returns a new VkVideoFormatPropertiesKHR instance allocated on the specified MemoryStack.

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

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

public static VkComponentMapping
ncomponentMapping(long struct)

Unsafe version of componentMapping.

public static int
nformat(long struct)

Unsafe version of format.

public static int
nimageCreateFlags(long struct)

Unsafe version of imageCreateFlags.

public static int
nimageTiling(long struct)

Unsafe version of imageTiling.

public static int
nimageType(long struct)

Unsafe version of imageType.

public static int
nimageUsageFlags(long struct)

Unsafe version of imageUsageFlags.

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

Sets the specified value to the pNext field.

public VkVideoFormatPropertiesKHR
set(int sType, long pNext)

Initializes this struct with the specified values.

public VkVideoFormatPropertiesKHR

Returns:

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

Sets the specified value to the sType field.

public VkVideoFormatPropertiesKHR
sType$Default()

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

COMPONENTMAPPINGback to summary
public static final int COMPONENTMAPPING

The struct member offsets.

FORMATback to summary
public static final int FORMAT

The struct member offsets.

IMAGECREATEFLAGSback to summary
public static final int IMAGECREATEFLAGS

The struct member offsets.

IMAGETILINGback to summary
public static final int IMAGETILING

The struct member offsets.

IMAGETYPEback to summary
public static final int IMAGETYPE

The struct member offsets.

IMAGEUSAGEFLAGSback to summary
public static final int IMAGEUSAGEFLAGS

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

VkVideoFormatPropertiesKHRback to summary
protected VkVideoFormatPropertiesKHR(long address, ByteBuffer container)
VkVideoFormatPropertiesKHRback to summary
public VkVideoFormatPropertiesKHR(ByteBuffer container)

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

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

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

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static VkVideoFormatPropertiesKHR calloc(MemoryStack stack)

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

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

componentMappingback to summary
public VkComponentMapping componentMapping()

defines the color channel order used for the format. format along with componentMapping describe how the color channels are ordered when producing video decoder output or are expected to be ordered in video encoder input, when applicable. If the format reported does not require component swizzling then all members of componentMapping will be set to COMPONENT_SWIZZLE_IDENTITY.

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

Returns a new VkVideoFormatPropertiesKHR instance allocated with BufferUtils.

createback to summary
public static VkVideoFormatPropertiesKHR create(long address)

Returns a new VkVideoFormatPropertiesKHR instance for the specified memory address.

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

Returns a new VkVideoFormatPropertiesKHR.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a VkVideoFormatPropertiesKHR.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static VkVideoFormatPropertiesKHR createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

Annotations
@Nullable
formatback to summary
public int format()

a VkFormat that specifies the format that can be used with the specified video profiles and image usages.

Annotations
@NativeType:VkFormat
imageCreateFlagsback to summary
public int imageCreateFlags()

a bitmask of VkImageCreateFlagBits specifying the supported image creation flags for the format.

Annotations
@NativeType:VkImageCreateFlags
imageTilingback to summary
public int imageTiling()

a VkImageTiling that specifies the image tiling the format can be used with.

Annotations
@NativeType:VkImageTiling
imageTypeback to summary
public int imageType()

a VkImageType that specifies the image type the format can be used with.

Annotations
@NativeType:VkImageType
imageUsageFlagsback to summary
public int imageUsageFlags()

a bitmask of VkImageUsageFlagBits specifying the supported image usage flags for the format.

Annotations
@NativeType:VkImageUsageFlags
mallocback to summary
public static VkVideoFormatPropertiesKHR malloc()

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

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

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static VkVideoFormatPropertiesKHR malloc(MemoryStack stack)

Returns a new VkVideoFormatPropertiesKHR instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

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

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

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

ncomponentMappingback to summary
public static VkComponentMapping ncomponentMapping(long struct)

Unsafe version of componentMapping.

nformatback to summary
public static int nformat(long struct)

Unsafe version of format.

nimageCreateFlagsback to summary
public static int nimageCreateFlags(long struct)

Unsafe version of imageCreateFlags.

nimageTilingback to summary
public static int nimageTiling(long struct)

Unsafe version of imageTiling.

nimageTypeback to summary
public static int nimageType(long struct)

Unsafe version of imageType.

nimageUsageFlagsback to summary
public static int nimageUsageFlags(long struct)

Unsafe version of imageUsageFlags.

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

Sets the specified value to the pNext field.

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

Initializes this struct with the specified values.

setback to summary
public VkVideoFormatPropertiesKHR set(VkVideoFormatPropertiesKHR src)

Copies the specified struct data to this struct.

Parameters
src:VkVideoFormatPropertiesKHR

the source struct

Returns:VkVideoFormatPropertiesKHR

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

Sets the specified value to the sType field.

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

Sets the STRUCTURE_TYPE_VIDEO_FORMAT_PROPERTIES_KHR value to the sType field.

org.lwjgl.vulkan back to summary

public Class VkVideoFormatPropertiesKHR.Buffer

extends StructBuffer<VkVideoFormatPropertiesKHR, VkVideoFormatPropertiesKHR.Buffer>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable
An array of VkVideoFormatPropertiesKHR structs.

Field Summary

Modifier and TypeField and Description
private static final VkVideoFormatPropertiesKHR
ELEMENT_FACTORY

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new VkVideoFormatPropertiesKHR.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
public VkComponentMapping

Returns:

a VkComponentMapping view of the VkVideoFormatPropertiesKHR#componentMapping field.
componentMapping()

public int

Returns:

the value of the VkVideoFormatPropertiesKHR#format field.
format()

protected VkVideoFormatPropertiesKHR
getElementFactory()

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

public int

Returns:

the value of the VkVideoFormatPropertiesKHR#imageCreateFlags field.
imageCreateFlags()

public int

Returns:

the value of the VkVideoFormatPropertiesKHR#imageTiling field.
imageTiling()

public int

Returns:

the value of the VkVideoFormatPropertiesKHR#imageType field.
imageType()

public int

Returns:

the value of the VkVideoFormatPropertiesKHR#imageUsageFlags field.
imageUsageFlags()

public long

Returns:

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

public VkVideoFormatPropertiesKHR.Buffer
pNext(long value)

Sets the specified value to the VkVideoFormatPropertiesKHR#pNext field.

protected VkVideoFormatPropertiesKHR.Buffer
self()

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

public int

Returns:

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

public VkVideoFormatPropertiesKHR.Buffer
sType(int value)

Sets the specified value to the VkVideoFormatPropertiesKHR#sType field.

public VkVideoFormatPropertiesKHR.Buffer
sType$Default()

Sets the STRUCTURE_TYPE_VIDEO_FORMAT_PROPERTIES_KHR value to the VkVideoFormatPropertiesKHR#sType field.

Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final VkVideoFormatPropertiesKHR ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

Creates a new VkVideoFormatPropertiesKHR.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 VkVideoFormatPropertiesKHR#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

componentMappingback to summary
public VkComponentMapping componentMapping()
Returns:VkComponentMapping

a VkComponentMapping view of the VkVideoFormatPropertiesKHR#componentMapping field.

formatback to summary
public int format()
Returns:int

the value of the VkVideoFormatPropertiesKHR#format field.

Annotations
@NativeType:VkFormat
getElementFactoryback to summary
protected VkVideoFormatPropertiesKHR getElementFactory()

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

Annotations
@Override
imageCreateFlagsback to summary
public int imageCreateFlags()
Returns:int

the value of the VkVideoFormatPropertiesKHR#imageCreateFlags field.

Annotations
@NativeType:VkImageCreateFlags
imageTilingback to summary
public int imageTiling()
Returns:int

the value of the VkVideoFormatPropertiesKHR#imageTiling field.

Annotations
@NativeType:VkImageTiling
imageTypeback to summary
public int imageType()
Returns:int

the value of the VkVideoFormatPropertiesKHR#imageType field.

Annotations
@NativeType:VkImageType
imageUsageFlagsback to summary
public int imageUsageFlags()
Returns:int

the value of the VkVideoFormatPropertiesKHR#imageUsageFlags field.

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

the value of the VkVideoFormatPropertiesKHR#pNext field.

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

Sets the specified value to the VkVideoFormatPropertiesKHR#pNext field.

selfback to summary
protected VkVideoFormatPropertiesKHR.Buffer self()

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

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

the value of the VkVideoFormatPropertiesKHR#sType field.

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

Sets the specified value to the VkVideoFormatPropertiesKHR#sType field.

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

Sets the STRUCTURE_TYPE_VIDEO_FORMAT_PROPERTIES_KHR value to the VkVideoFormatPropertiesKHR#sType field.