Top Description Inners Fields Constructors Methods
org.lwjgl.vulkan

public Class VkSamplerYcbcrConversionImageFormatProperties

extends Struct<VkSamplerYcbcrConversionImageFormatProperties>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable
Known Direct Subclasses
org.lwjgl.vulkan.VkSamplerYcbcrConversionImageFormatPropertiesKHR
Imports
javax.annotation.*, java.nio.*, org.lwjgl.*, org.lwjgl.system.*
Structure specifying combined image sampler descriptor count for multi-planar images.
Valid Usage (Implicit)

Layout


struct VkSamplerYcbcrConversionImageFormatProperties {
    VkStructureType sType;
    void * pNext;
    uint32_t combinedImageSamplerDescriptorCount;
}

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class
VkSamplerYcbcrConversionImageFormatProperties.Buffer

An array of VkSamplerYcbcrConversionImageFormatProperties structs.

Field Summary

Modifier and TypeField and Description
public static final int
ALIGNOF

The struct alignment in bytes.

public static final int
COMBINEDIMAGESAMPLERDESCRIPTORCOUNT

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

public
VkSamplerYcbcrConversionImageFormatProperties(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public static VkSamplerYcbcrConversionImageFormatProperties
calloc()

Returns a new VkSamplerYcbcrConversionImageFormatProperties instance allocated with memCalloc.

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

Returns a new VkSamplerYcbcrConversionImageFormatProperties.Buffer instance allocated with memCalloc.

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

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

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

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

public static VkSamplerYcbcrConversionImageFormatProperties
callocStack()

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

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

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

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

the number of combined image sampler descriptors that the implementation uses to access the format.

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

Returns a new VkSamplerYcbcrConversionImageFormatProperties instance allocated with BufferUtils.

public static VkSamplerYcbcrConversionImageFormatProperties
create(long address)

Returns a new VkSamplerYcbcrConversionImageFormatProperties instance for the specified memory address.

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

Returns a new VkSamplerYcbcrConversionImageFormatProperties.Buffer instance allocated with BufferUtils.

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

Create a VkSamplerYcbcrConversionImageFormatProperties.Buffer instance at the specified memory.

public static VkSamplerYcbcrConversionImageFormatProperties
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public static VkSamplerYcbcrConversionImageFormatProperties
malloc()

Returns a new VkSamplerYcbcrConversionImageFormatProperties instance allocated with memAlloc.

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

Returns a new VkSamplerYcbcrConversionImageFormatProperties.Buffer instance allocated with memAlloc.

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

Returns a new VkSamplerYcbcrConversionImageFormatProperties instance allocated on the specified MemoryStack.

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

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

public static VkSamplerYcbcrConversionImageFormatProperties
mallocStack()

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

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

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

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

Unsafe version of combinedImageSamplerDescriptorCount.

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

Sets the specified value to the pNext field.

public VkSamplerYcbcrConversionImageFormatProperties
set(int sType, long pNext)

Initializes this struct with the specified values.

public VkSamplerYcbcrConversionImageFormatProperties

Returns:

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

Sets the specified value to the sType field.

public VkSamplerYcbcrConversionImageFormatProperties
sType$Default()

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

COMBINEDIMAGESAMPLERDESCRIPTORCOUNTback to summary
public static final int COMBINEDIMAGESAMPLERDESCRIPTORCOUNT

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

VkSamplerYcbcrConversionImageFormatPropertiesback to summary
protected VkSamplerYcbcrConversionImageFormatProperties(long address, ByteBuffer container)
VkSamplerYcbcrConversionImageFormatPropertiesback to summary
public VkSamplerYcbcrConversionImageFormatProperties(ByteBuffer container)

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

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

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

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static VkSamplerYcbcrConversionImageFormatProperties calloc(MemoryStack stack)

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

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

callocStackback to summary
public static VkSamplerYcbcrConversionImageFormatProperties callocStack()

Deprecated

Deprecated for removal in 3.4.0. Use calloc(MemoryStack) instead.

Annotations
@Deprecated
callocStackback to summary
public static VkSamplerYcbcrConversionImageFormatProperties callocStack(MemoryStack stack)

Deprecated

Deprecated for removal in 3.4.0. Use calloc(MemoryStack) instead.

Annotations
@Deprecated
callocStackback to summary
public static VkSamplerYcbcrConversionImageFormatProperties.Buffer callocStack(int capacity)

Deprecated

Deprecated for removal in 3.4.0. Use calloc(int, MemoryStack) instead.

Annotations
@Deprecated
callocStackback to summary
public static VkSamplerYcbcrConversionImageFormatProperties.Buffer callocStack(int capacity, MemoryStack stack)

Deprecated

Deprecated for removal in 3.4.0. Use calloc(int, MemoryStack) instead.

Annotations
@Deprecated
combinedImageSamplerDescriptorCountback to summary
public int combinedImageSamplerDescriptorCount()

the number of combined image sampler descriptors that the implementation uses to access the format.

Annotations
@NativeType:uint32_t
createback to summary
protected VkSamplerYcbcrConversionImageFormatProperties 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 VkSamplerYcbcrConversionImageFormatProperties create()

Returns a new VkSamplerYcbcrConversionImageFormatProperties instance allocated with BufferUtils.

createback to summary
public static VkSamplerYcbcrConversionImageFormatProperties create(long address)

Returns a new VkSamplerYcbcrConversionImageFormatProperties instance for the specified memory address.

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

Returns a new VkSamplerYcbcrConversionImageFormatProperties.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a VkSamplerYcbcrConversionImageFormatProperties.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static VkSamplerYcbcrConversionImageFormatProperties createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

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

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

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

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static VkSamplerYcbcrConversionImageFormatProperties malloc(MemoryStack stack)

Returns a new VkSamplerYcbcrConversionImageFormatProperties instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

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

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

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

mallocStackback to summary
public static VkSamplerYcbcrConversionImageFormatProperties mallocStack()

Deprecated

Deprecated for removal in 3.4.0. Use malloc(MemoryStack) instead.

Annotations
@Deprecated
mallocStackback to summary
public static VkSamplerYcbcrConversionImageFormatProperties mallocStack(MemoryStack stack)

Deprecated

Deprecated for removal in 3.4.0. Use malloc(MemoryStack) instead.

Annotations
@Deprecated
mallocStackback to summary
public static VkSamplerYcbcrConversionImageFormatProperties.Buffer mallocStack(int capacity)

Deprecated

Deprecated for removal in 3.4.0. Use malloc(int, MemoryStack) instead.

Annotations
@Deprecated
mallocStackback to summary
public static VkSamplerYcbcrConversionImageFormatProperties.Buffer mallocStack(int capacity, MemoryStack stack)

Deprecated

Deprecated for removal in 3.4.0. Use malloc(int, MemoryStack) instead.

Annotations
@Deprecated
ncombinedImageSamplerDescriptorCountback to summary
public static int ncombinedImageSamplerDescriptorCount(long struct)

Unsafe version of combinedImageSamplerDescriptorCount.

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

Sets the specified value to the pNext field.

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

Initializes this struct with the specified values.

setback to summary
public VkSamplerYcbcrConversionImageFormatProperties set(VkSamplerYcbcrConversionImageFormatProperties src)

Copies the specified struct data to this struct.

Parameters
src:VkSamplerYcbcrConversionImageFormatProperties

the source struct

Returns:VkSamplerYcbcrConversionImageFormatProperties

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

Sets the specified value to the sType field.

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

Sets the STRUCTURE_TYPE_SAMPLER_YCBCR_CONVERSION_IMAGE_FORMAT_PROPERTIES value to the sType field.

org.lwjgl.vulkan back to summary

public Class VkSamplerYcbcrConversionImageFormatProperties.Buffer

extends StructBuffer<VkSamplerYcbcrConversionImageFormatProperties, VkSamplerYcbcrConversionImageFormatProperties.Buffer>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable
Known Direct Subclasses
org.lwjgl.vulkan.VkSamplerYcbcrConversionImageFormatPropertiesKHR.Buffer
An array of VkSamplerYcbcrConversionImageFormatProperties structs.

Field Summary

Modifier and TypeField and Description
private static final VkSamplerYcbcrConversionImageFormatProperties
ELEMENT_FACTORY

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new VkSamplerYcbcrConversionImageFormatProperties.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 int

Returns:

the value of the VkSamplerYcbcrConversionImageFormatProperties#combinedImageSamplerDescriptorCount field.
combinedImageSamplerDescriptorCount()

protected VkSamplerYcbcrConversionImageFormatProperties
getElementFactory()

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

public long

Returns:

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

public VkSamplerYcbcrConversionImageFormatProperties.Buffer
pNext(long value)

Sets the specified value to the VkSamplerYcbcrConversionImageFormatProperties#pNext field.

protected VkSamplerYcbcrConversionImageFormatProperties.Buffer
self()

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

public int

Returns:

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

public VkSamplerYcbcrConversionImageFormatProperties.Buffer
sType(int value)

Sets the specified value to the VkSamplerYcbcrConversionImageFormatProperties#sType field.

public VkSamplerYcbcrConversionImageFormatProperties.Buffer
sType$Default()

Sets the STRUCTURE_TYPE_SAMPLER_YCBCR_CONVERSION_IMAGE_FORMAT_PROPERTIES value to the VkSamplerYcbcrConversionImageFormatProperties#sType field.

Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final VkSamplerYcbcrConversionImageFormatProperties ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

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

combinedImageSamplerDescriptorCountback to summary
public int combinedImageSamplerDescriptorCount()
Returns:int

the value of the VkSamplerYcbcrConversionImageFormatProperties#combinedImageSamplerDescriptorCount field.

Annotations
@NativeType:uint32_t
getElementFactoryback to summary
protected VkSamplerYcbcrConversionImageFormatProperties getElementFactory()

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

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

the value of the VkSamplerYcbcrConversionImageFormatProperties#pNext field.

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

Sets the specified value to the VkSamplerYcbcrConversionImageFormatProperties#pNext field.

selfback to summary
protected VkSamplerYcbcrConversionImageFormatProperties.Buffer self()

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

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

the value of the VkSamplerYcbcrConversionImageFormatProperties#sType field.

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

Sets the specified value to the VkSamplerYcbcrConversionImageFormatProperties#sType field.

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

Sets the STRUCTURE_TYPE_SAMPLER_YCBCR_CONVERSION_IMAGE_FORMAT_PROPERTIES value to the VkSamplerYcbcrConversionImageFormatProperties#sType field.