Top Description Inners Fields Constructors Methods
org.lwjgl.vulkan

public Class VkSamplerYcbcrConversionCreateInfo

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

Structure specifying the parameters of the newly created conversion.
Description
Note

Setting forceExplicitReconstruction to TRUE may have a performance penalty on implementations where explicit reconstruction is not the default mode of operation.

If format supports FORMAT_FEATURE_SAMPLED_IMAGE_YCBCR_CONVERSION_CHROMA_RECONSTRUCTION_EXPLICIT_BIT the forceExplicitReconstruction value behaves as if it was set to TRUE.

If the pNext chain includes a VkExternalFormatANDROID structure with non-zero externalFormat member, the sampler Y′CBCR conversion object represents an external format conversion, and format must be FORMAT_UNDEFINED. Such conversions must only be used to sample image views with a matching external format. When creating an external format conversion, the value of components is ignored.

Valid Usage
Valid Usage (Implicit)

If chromaFilter is FILTER_NEAREST, chroma samples are reconstructed to luma component resolution using nearest-neighbour sampling. Otherwise, chroma samples are reconstructed using interpolation. More details can be found in the description of sampler Y′CBCR conversion in the Image Operations chapter.

See Also

VkComponentMapping, CreateSamplerYcbcrConversion, CreateSamplerYcbcrConversionKHR

Layout


struct VkSamplerYcbcrConversionCreateInfo {
    VkStructureType sType;
    void const * pNext;
    VkFormat format;
    VkSamplerYcbcrModelConversion ycbcrModel;
    VkSamplerYcbcrRange ycbcrRange;
    VkComponentMapping components;
    VkChromaLocation xChromaOffset;
    VkChromaLocation yChromaOffset;
    VkFilter chromaFilter;
    VkBool32 forceExplicitReconstruction;
}

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
CHROMAFILTER

The struct member offsets.

public static final int
COMPONENTS

The struct member offsets.

public static final int
FORCEEXPLICITRECONSTRUCTION

The struct member offsets.

public static final int
FORMAT

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.

public static final int
XCHROMAOFFSET

The struct member offsets.

public static final int
YCBCRMODEL

The struct member offsets.

public static final int
YCBCRRANGE

The struct member offsets.

public static final int
YCHROMAOFFSET

The struct member offsets.

Inherited from org.lwjgl.system.Struct:
containerDEFAULT_ALIGN_ASDEFAULT_PACK_ALIGNMENT

Constructor Summary

AccessConstructor and Description
protected
public
VkSamplerYcbcrConversionCreateInfo(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public static VkSamplerYcbcrConversionCreateInfo
calloc()

Returns a new VkSamplerYcbcrConversionCreateInfo instance allocated with memCalloc.

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

Returns a new VkSamplerYcbcrConversionCreateInfo.Buffer instance allocated with memCalloc.

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

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

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

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

public static VkSamplerYcbcrConversionCreateInfo
callocStack()

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

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

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

Deprecated
Deprecated for removal in 3.4.0.
public int
chromaFilter()

the filter for chroma reconstruction.

public VkSamplerYcbcrConversionCreateInfo
chromaFilter(int value)

Sets the specified value to the chromaFilter field.

public VkComponentMapping
components()

applies a swizzle based on VkComponentSwizzle enums prior to range expansion and color model conversion.

public VkSamplerYcbcrConversionCreateInfo
components(VkComponentMapping value)

Copies the specified VkComponentMapping to the components field.

public VkSamplerYcbcrConversionCreateInfo
components(Consumer<VkComponentMapping> consumer)

Passes the components field to the specified Consumer.

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

Returns a new VkSamplerYcbcrConversionCreateInfo instance allocated with BufferUtils.

public static VkSamplerYcbcrConversionCreateInfo
create(long address)

Returns a new VkSamplerYcbcrConversionCreateInfo instance for the specified memory address.

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

Returns a new VkSamplerYcbcrConversionCreateInfo.Buffer instance allocated with BufferUtils.

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

Create a VkSamplerYcbcrConversionCreateInfo.Buffer instance at the specified memory.

public static VkSamplerYcbcrConversionCreateInfo
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public boolean
forceExplicitReconstruction()

can be used to ensure that reconstruction is done explicitly, if supported.

public VkSamplerYcbcrConversionCreateInfo
forceExplicitReconstruction(boolean value)

Sets the specified value to the forceExplicitReconstruction field.

public int
format()

the format of the image from which color information will be retrieved.

public VkSamplerYcbcrConversionCreateInfo
format(int value)

Sets the specified value to the format field.

public static VkSamplerYcbcrConversionCreateInfo
malloc()

Returns a new VkSamplerYcbcrConversionCreateInfo instance allocated with memAlloc.

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

Returns a new VkSamplerYcbcrConversionCreateInfo.Buffer instance allocated with memAlloc.

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

Returns a new VkSamplerYcbcrConversionCreateInfo instance allocated on the specified MemoryStack.

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

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

public static VkSamplerYcbcrConversionCreateInfo
mallocStack()

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

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

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

Deprecated
Deprecated for removal in 3.4.0.
public static int
nchromaFilter(long struct)

Unsafe version of chromaFilter.

public static void
nchromaFilter(long struct, int value)

Unsafe version of chromaFilter.

public static VkComponentMapping
ncomponents(long struct)

Unsafe version of components.

public static void
ncomponents(long struct, VkComponentMapping value)

Unsafe version of components.

public static int
public static void
nforceExplicitReconstruction(long struct, int value)

Unsafe version of forceExplicitReconstruction.

public static int
nformat(long struct)

Unsafe version of format.

public static void
nformat(long struct, int value)

Unsafe version of format.

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 static int
nxChromaOffset(long struct)

Unsafe version of xChromaOffset.

public static void
nxChromaOffset(long struct, int value)

Unsafe version of xChromaOffset.

public static int
nycbcrModel(long struct)

Unsafe version of ycbcrModel.

public static void
nycbcrModel(long struct, int value)

Unsafe version of ycbcrModel.

public static int
nycbcrRange(long struct)

Unsafe version of ycbcrRange.

public static void
nycbcrRange(long struct, int value)

Unsafe version of ycbcrRange.

public static int
nyChromaOffset(long struct)

Unsafe version of yChromaOffset.

public static void
nyChromaOffset(long struct, int value)

Unsafe version of yChromaOffset.

public long
pNext()

NULL or a pointer to a structure extending this structure.

public VkSamplerYcbcrConversionCreateInfo
pNext(long value)

Sets the specified value to the pNext field.

public VkSamplerYcbcrConversionCreateInfo
pNext(VkExternalFormatANDROID value)

Prepends the specified VkExternalFormatANDROID value to the pNext chain.

public VkSamplerYcbcrConversionCreateInfo
public VkSamplerYcbcrConversionCreateInfo
set(int sType, long pNext, int format, int ycbcrModel, int ycbcrRange, VkComponentMapping components, int xChromaOffset, int yChromaOffset, int chromaFilter, boolean forceExplicitReconstruction)

Initializes this struct with the specified values.

public VkSamplerYcbcrConversionCreateInfo

Returns:

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

Sets the specified value to the sType field.

public VkSamplerYcbcrConversionCreateInfo
public int
xChromaOffset()

describes the sample location associated with downsampled chroma components in the x dimension.

public VkSamplerYcbcrConversionCreateInfo
xChromaOffset(int value)

Sets the specified value to the xChromaOffset field.

public int
ycbcrModel()

describes the color matrix for conversion between color models.

public VkSamplerYcbcrConversionCreateInfo
ycbcrModel(int value)

Sets the specified value to the ycbcrModel field.

public int
ycbcrRange()

describes whether the encoded values have headroom and foot room, or whether the encoding uses the full numerical range.

public VkSamplerYcbcrConversionCreateInfo
ycbcrRange(int value)

Sets the specified value to the ycbcrRange field.

public int
yChromaOffset()

describes the sample location associated with downsampled chroma components in the y dimension.

public VkSamplerYcbcrConversionCreateInfo
yChromaOffset(int value)

Sets the specified value to the yChromaOffset field.

Inherited from org.lwjgl.system.Struct:
__array__array__array__checkContainer__checkMalloc__create__getContainer__getContainer__member__member__member__padding__padding__struct__struct__union__unionclearfreeisNullvalidate