Package org.lwjgl.vulkan

Class VkImageViewSampleWeightCreateInfoQCOM

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkImageViewSampleWeightCreateInfoQCOM>

org.lwjgl.vulkan.VkImageViewSampleWeightCreateInfoQCOM

All Implemented Interfaces:

AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer

public class VkImageViewSampleWeightCreateInfoQCOM
extends org.lwjgl.system.Struct<VkImageViewSampleWeightCreateInfoQCOM>
implements org.lwjgl.system.NativeResource

Structure describing weight sampling parameters for image view.

Description

The filterCenter specifies the origin or center of the filter kernel, as described in Weight Sampling Operation. The numPhases describes the number of sub-pixel filter phases as described in Weight Sampling Phases.

Valid Usage

• filterSize.width must be less than or equal to VkPhysicalDeviceImageProcessingPropertiesQCOM::maxWeightFilterDimension.width
• filterSize.height must be less than or equal to VkPhysicalDeviceImageProcessingPropertiesQCOM::maxWeightFilterDimension.height
• filterCenter.x must be less than or equal to (filterSize.width - 1)
• filterCenter.y must be less than or equal to (filterSize.height - 1)
• numPhases must be a power of two squared value (i.e., 1, 4, 16, 64, 256, etc.)
• numPhases must be less than or equal to VkPhysicalDeviceImageProcessingPropertiesQCOM::maxWeightFilterPhases

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_IMAGE_VIEW_SAMPLE_WEIGHT_CREATE_INFO_QCOM

See Also

VkExtent2D, VkOffset2D

Layout

 struct VkImageViewSampleWeightCreateInfoQCOM {
     VkStructureType sType();
     void const * pNext();
     VkOffset2D filterCenter();
     VkExtent2D filterSize();
     uint32_t numPhases();
 }

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	VkImageViewSampleWeightCreateInfoQCOM.Buffer	An array of VkImageViewSampleWeightCreateInfoQCOM structs.

Nested classes/interfaces inherited from class org.lwjgl.system.Struct

org.lwjgl.system.Struct.StructValidation

Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer

org.lwjgl.system.Pointer.Default

Field Summary

Fields

Modifier and Type	Field	Description
static final int	ALIGNOF	The struct alignment in bytes.
static final int	FILTERCENTER	The struct member offsets.
static final int	FILTERSIZE	The struct member offsets.
static final int	NUMPHASES	The struct member offsets.
static final int	PNEXT	The struct member offsets.
static final int	SIZEOF	The struct size in bytes.
static final int	STYPE	The struct member offsets.

Fields inherited from interface org.lwjgl.system.Pointer

BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE

Constructor Summary

Constructors

Constructor	Description
VkImageViewSampleWeightCreateInfoQCOM(ByteBuffer container)	Creates a VkImageViewSampleWeightCreateInfoQCOM instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and Type	Method	Description
static VkImageViewSampleWeightCreateInfoQCOM	calloc()	Returns a new VkImageViewSampleWeightCreateInfoQCOM instance allocated with memCalloc.
static VkImageViewSampleWeightCreateInfoQCOM.Buffer	calloc(int capacity)	Returns a new VkImageViewSampleWeightCreateInfoQCOM.Buffer instance allocated with memCalloc.
static VkImageViewSampleWeightCreateInfoQCOM.Buffer	calloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkImageViewSampleWeightCreateInfoQCOM.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkImageViewSampleWeightCreateInfoQCOM	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkImageViewSampleWeightCreateInfoQCOM instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkImageViewSampleWeightCreateInfoQCOM	create()	Returns a new VkImageViewSampleWeightCreateInfoQCOM instance allocated with BufferUtils.
static VkImageViewSampleWeightCreateInfoQCOM.Buffer	create(int capacity)	Returns a new VkImageViewSampleWeightCreateInfoQCOM.Buffer instance allocated with BufferUtils.
static VkImageViewSampleWeightCreateInfoQCOM	create(long address)	Returns a new VkImageViewSampleWeightCreateInfoQCOM instance for the specified memory address.
static VkImageViewSampleWeightCreateInfoQCOM.Buffer	create(long address, int capacity)	Create a VkImageViewSampleWeightCreateInfoQCOM.Buffer instance at the specified memory.
static @Nullable VkImageViewSampleWeightCreateInfoQCOM	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable VkImageViewSampleWeightCreateInfoQCOM.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
VkOffset2D	filterCenter()	a VkOffset2D describing the location of the weight filter origin.
VkImageViewSampleWeightCreateInfoQCOM	filterCenter(Consumer<VkOffset2D> consumer)	Passes the filterCenter() field to the specified Consumer.
VkImageViewSampleWeightCreateInfoQCOM	filterCenter(VkOffset2D value)	Copies the specified VkOffset2D to the filterCenter() field.
VkExtent2D	filterSize()	a VkExtent2D specifying weight filter dimensions.
VkImageViewSampleWeightCreateInfoQCOM	filterSize(Consumer<VkExtent2D> consumer)	Passes the filterSize() field to the specified Consumer.
VkImageViewSampleWeightCreateInfoQCOM	filterSize(VkExtent2D value)	Copies the specified VkExtent2D to the filterSize() field.
static VkImageViewSampleWeightCreateInfoQCOM	malloc()	Returns a new VkImageViewSampleWeightCreateInfoQCOM instance allocated with memAlloc.
static VkImageViewSampleWeightCreateInfoQCOM.Buffer	malloc(int capacity)	Returns a new VkImageViewSampleWeightCreateInfoQCOM.Buffer instance allocated with memAlloc.
static VkImageViewSampleWeightCreateInfoQCOM.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkImageViewSampleWeightCreateInfoQCOM.Buffer instance allocated on the specified MemoryStack.
static VkImageViewSampleWeightCreateInfoQCOM	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkImageViewSampleWeightCreateInfoQCOM instance allocated on the specified MemoryStack.
static VkOffset2D	nfilterCenter(long struct)	Unsafe version of filterCenter().
static void	nfilterCenter(long struct, VkOffset2D value)	Unsafe version of filterCenter.
static VkExtent2D	nfilterSize(long struct)	Unsafe version of filterSize().
static void	nfilterSize(long struct, VkExtent2D value)	Unsafe version of filterSize.
static int	nnumPhases(long struct)	Unsafe version of numPhases().
static void	nnumPhases(long struct, int value)	Unsafe version of numPhases.
static long	npNext(long struct)	Unsafe version of pNext().
static void	npNext(long struct, long value)	Unsafe version of pNext.
static int	nsType(long struct)	Unsafe version of sType().
static void	nsType(long struct, int value)	Unsafe version of sType.
int	numPhases()	number of sub-pixel filter phases.
VkImageViewSampleWeightCreateInfoQCOM	numPhases(int value)	Sets the specified value to the numPhases() field.
long	pNext()	NULL or a pointer to a structure extending this structure.
VkImageViewSampleWeightCreateInfoQCOM	pNext(long value)	Sets the specified value to the pNext() field.
VkImageViewSampleWeightCreateInfoQCOM	set(int sType, long pNext, VkOffset2D filterCenter, VkExtent2D filterSize, int numPhases)	Initializes this struct with the specified values.
VkImageViewSampleWeightCreateInfoQCOM	set(VkImageViewSampleWeightCreateInfoQCOM src)	Copies the specified struct data to this struct.
int	sizeof()
int	sType()	a VkStructureType value identifying this structure.
VkImageViewSampleWeightCreateInfoQCOM	sType(int value)	Sets the specified value to the sType() field.
VkImageViewSampleWeightCreateInfoQCOM	sType$Default()	Sets the STRUCTURE_TYPE_IMAGE_VIEW_SAMPLE_WEIGHT_CREATE_INFO_QCOM value to the sType() field.

Methods inherited from class org.lwjgl.system.Struct

clear, free, isNull, validate, validate

Methods inherited from class org.lwjgl.system.Pointer.Default

address, equals, hashCode, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.lwjgl.system.NativeResource

close, free

Field Details

SIZEOF

public static final int SIZEOF

The struct size in bytes.

ALIGNOF

public static final int ALIGNOF

The struct alignment in bytes.

STYPE

public static final int STYPE

The struct member offsets.

PNEXT

public static final int PNEXT

The struct member offsets.

FILTERCENTER

public static final int FILTERCENTER

The struct member offsets.

FILTERSIZE

public static final int FILTERSIZE

The struct member offsets.

NUMPHASES

public static final int NUMPHASES

The struct member offsets.

Constructor Details

VkImageViewSampleWeightCreateInfoQCOM

public VkImageViewSampleWeightCreateInfoQCOM(ByteBuffer container)

Creates a VkImageViewSampleWeightCreateInfoQCOM 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 Details

sizeof

public int sizeof()

Specified by:

sizeof in class org.lwjgl.system.Struct<VkImageViewSampleWeightCreateInfoQCOM>

sType

public int sType()

a VkStructureType value identifying this structure.

pNext

public long pNext()

NULL or a pointer to a structure extending this structure.

filterCenter

public VkOffset2D filterCenter()

a VkOffset2D describing the location of the weight filter origin.

filterSize

public VkExtent2D filterSize()

a VkExtent2D specifying weight filter dimensions.

numPhases

public int numPhases()

number of sub-pixel filter phases.

sType

public VkImageViewSampleWeightCreateInfoQCOM sType(int value)

Sets the specified value to the sType() field.

sType$Default

public VkImageViewSampleWeightCreateInfoQCOM sType$Default()

Sets the STRUCTURE_TYPE_IMAGE_VIEW_SAMPLE_WEIGHT_CREATE_INFO_QCOM value to the sType() field.

pNext

public VkImageViewSampleWeightCreateInfoQCOM pNext(long value)

Sets the specified value to the pNext() field.

filterCenter

public VkImageViewSampleWeightCreateInfoQCOM filterCenter(VkOffset2D value)

Copies the specified VkOffset2D to the filterCenter() field.

filterCenter

public VkImageViewSampleWeightCreateInfoQCOM filterCenter(Consumer<VkOffset2D> consumer)

Passes the filterCenter() field to the specified Consumer.

filterSize

public VkImageViewSampleWeightCreateInfoQCOM filterSize(VkExtent2D value)

Copies the specified VkExtent2D to the filterSize() field.

filterSize

public VkImageViewSampleWeightCreateInfoQCOM filterSize(Consumer<VkExtent2D> consumer)

Passes the filterSize() field to the specified Consumer.

numPhases

public VkImageViewSampleWeightCreateInfoQCOM numPhases(int value)

Sets the specified value to the numPhases() field.

set

public VkImageViewSampleWeightCreateInfoQCOM set(int sType,
 long pNext,
 VkOffset2D filterCenter,
 VkExtent2D filterSize,
 int numPhases)

Initializes this struct with the specified values.

set

public VkImageViewSampleWeightCreateInfoQCOM set(VkImageViewSampleWeightCreateInfoQCOM src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static VkImageViewSampleWeightCreateInfoQCOM malloc()

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

calloc

public static VkImageViewSampleWeightCreateInfoQCOM calloc()

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

create

public static VkImageViewSampleWeightCreateInfoQCOM create()

Returns a new VkImageViewSampleWeightCreateInfoQCOM instance allocated with BufferUtils.

create

public static VkImageViewSampleWeightCreateInfoQCOM create(long address)

Returns a new VkImageViewSampleWeightCreateInfoQCOM instance for the specified memory address.

createSafe

public static @Nullable VkImageViewSampleWeightCreateInfoQCOM createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VkImageViewSampleWeightCreateInfoQCOM.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static VkImageViewSampleWeightCreateInfoQCOM.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static VkImageViewSampleWeightCreateInfoQCOM.Buffer create(int capacity)

Returns a new VkImageViewSampleWeightCreateInfoQCOM.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

public static VkImageViewSampleWeightCreateInfoQCOM.Buffer create(long address,
 int capacity)

Create a VkImageViewSampleWeightCreateInfoQCOM.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

public static @Nullable VkImageViewSampleWeightCreateInfoQCOM.Buffer createSafe(long address,
 int capacity)

Like create, but returns null if address is NULL.

malloc

public static VkImageViewSampleWeightCreateInfoQCOM malloc(org.lwjgl.system.MemoryStack stack)

Returns a new VkImageViewSampleWeightCreateInfoQCOM instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

public static VkImageViewSampleWeightCreateInfoQCOM calloc(org.lwjgl.system.MemoryStack stack)

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

Parameters:

stack - the stack from which to allocate

malloc

public static VkImageViewSampleWeightCreateInfoQCOM.Buffer malloc(int capacity,
 org.lwjgl.system.MemoryStack stack)

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

public static VkImageViewSampleWeightCreateInfoQCOM.Buffer calloc(int capacity,
 org.lwjgl.system.MemoryStack stack)

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

nsType

public static int nsType(long struct)

Unsafe version of sType().

npNext

public static long npNext(long struct)

Unsafe version of pNext().

nfilterCenter

public static VkOffset2D nfilterCenter(long struct)

Unsafe version of filterCenter().

nfilterSize

public static VkExtent2D nfilterSize(long struct)

Unsafe version of filterSize().

nnumPhases

public static int nnumPhases(long struct)

Unsafe version of numPhases().

nsType

public static void nsType(long struct,
 int value)

Unsafe version of sType.

npNext

public static void npNext(long struct,
 long value)

Unsafe version of pNext.

nfilterCenter

public static void nfilterCenter(long struct,
 VkOffset2D value)

Unsafe version of filterCenter.

nfilterSize

public static void nfilterSize(long struct,
 VkExtent2D value)

Unsafe version of filterSize.

nnumPhases

public static void nnumPhases(long struct,
 int value)

Unsafe version of numPhases.