Package org.lwjgl.vulkan

Class VkSamplerReductionModeCreateInfo

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkSamplerReductionModeCreateInfo>

org.lwjgl.vulkan.VkSamplerReductionModeCreateInfo

All Implemented Interfaces:

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

Direct Known Subclasses:

VkSamplerReductionModeCreateInfoEXT

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

Structure specifying sampler reduction mode.

Description

If the pNext chain of VkSamplerCreateInfo includes a VkSamplerReductionModeCreateInfo structure, then that structure includes a mode controlling how texture filtering combines texel values.

If this structure is not present, reductionMode is considered to be SAMPLER_REDUCTION_MODE_WEIGHTED_AVERAGE.

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_SAMPLER_REDUCTION_MODE_CREATE_INFO
• reductionMode must be a valid VkSamplerReductionMode value

Layout

 struct VkSamplerReductionModeCreateInfo {
     VkStructureType sType();
     void const * pNext();
     VkSamplerReductionMode reductionMode();
 }

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	VkSamplerReductionModeCreateInfo.Buffer	An array of VkSamplerReductionModeCreateInfo 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	PNEXT	The struct member offsets.
static final int	REDUCTIONMODE	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
VkSamplerReductionModeCreateInfo(ByteBuffer container)	Creates a VkSamplerReductionModeCreateInfo instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and Type	Method	Description
static VkSamplerReductionModeCreateInfo	calloc()	Returns a new VkSamplerReductionModeCreateInfo instance allocated with memCalloc.
static VkSamplerReductionModeCreateInfo.Buffer	calloc(int capacity)	Returns a new VkSamplerReductionModeCreateInfo.Buffer instance allocated with memCalloc.
static VkSamplerReductionModeCreateInfo.Buffer	calloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkSamplerReductionModeCreateInfo.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkSamplerReductionModeCreateInfo	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkSamplerReductionModeCreateInfo instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkSamplerReductionModeCreateInfo	create()	Returns a new VkSamplerReductionModeCreateInfo instance allocated with BufferUtils.
static VkSamplerReductionModeCreateInfo.Buffer	create(int capacity)	Returns a new VkSamplerReductionModeCreateInfo.Buffer instance allocated with BufferUtils.
static VkSamplerReductionModeCreateInfo	create(long address)	Returns a new VkSamplerReductionModeCreateInfo instance for the specified memory address.
static VkSamplerReductionModeCreateInfo.Buffer	create(long address, int capacity)	Create a VkSamplerReductionModeCreateInfo.Buffer instance at the specified memory.
static @Nullable VkSamplerReductionModeCreateInfo	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable VkSamplerReductionModeCreateInfo.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
static VkSamplerReductionModeCreateInfo	malloc()	Returns a new VkSamplerReductionModeCreateInfo instance allocated with memAlloc.
static VkSamplerReductionModeCreateInfo.Buffer	malloc(int capacity)	Returns a new VkSamplerReductionModeCreateInfo.Buffer instance allocated with memAlloc.
static VkSamplerReductionModeCreateInfo.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkSamplerReductionModeCreateInfo.Buffer instance allocated on the specified MemoryStack.
static VkSamplerReductionModeCreateInfo	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkSamplerReductionModeCreateInfo instance allocated on the specified MemoryStack.
static long	npNext(long struct)	Unsafe version of pNext().
static void	npNext(long struct, long value)	Unsafe version of pNext.
static int	nreductionMode(long struct)	Unsafe version of reductionMode().
static void	nreductionMode(long struct, int value)	Unsafe version of reductionMode.
static int	nsType(long struct)	Unsafe version of sType().
static void	nsType(long struct, int value)	Unsafe version of sType.
long	pNext()	NULL or a pointer to a structure extending this structure.
VkSamplerReductionModeCreateInfo	pNext(long value)	Sets the specified value to the pNext() field.
int	reductionMode()	a VkSamplerReductionMode value controlling how texture filtering combines texel values.
VkSamplerReductionModeCreateInfo	reductionMode(int value)	Sets the specified value to the reductionMode() field.
VkSamplerReductionModeCreateInfo	set(int sType, long pNext, int reductionMode)	Initializes this struct with the specified values.
VkSamplerReductionModeCreateInfo	set(VkSamplerReductionModeCreateInfo src)	Copies the specified struct data to this struct.
int	sizeof()
int	sType()	a VkStructureType value identifying this structure.
VkSamplerReductionModeCreateInfo	sType(int value)	Sets the specified value to the sType() field.
VkSamplerReductionModeCreateInfo	sType$Default()	Sets the STRUCTURE_TYPE_SAMPLER_REDUCTION_MODE_CREATE_INFO 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.

REDUCTIONMODE

public static final int REDUCTIONMODE

The struct member offsets.

Constructor Details

VkSamplerReductionModeCreateInfo

public VkSamplerReductionModeCreateInfo(ByteBuffer container)

Creates a VkSamplerReductionModeCreateInfo 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<VkSamplerReductionModeCreateInfo>

sType

public int sType()

a VkStructureType value identifying this structure.

pNext

public long pNext()

NULL or a pointer to a structure extending this structure.

reductionMode

public int reductionMode()

a VkSamplerReductionMode value controlling how texture filtering combines texel values.

sType

public VkSamplerReductionModeCreateInfo sType(int value)

Sets the specified value to the sType() field.

sType$Default

public VkSamplerReductionModeCreateInfo sType$Default()

Sets the STRUCTURE_TYPE_SAMPLER_REDUCTION_MODE_CREATE_INFO value to the sType() field.

pNext

public VkSamplerReductionModeCreateInfo pNext(long value)

Sets the specified value to the pNext() field.

reductionMode

public VkSamplerReductionModeCreateInfo reductionMode(int value)

Sets the specified value to the reductionMode() field.

set

public VkSamplerReductionModeCreateInfo set(int sType,
 long pNext,
 int reductionMode)

Initializes this struct with the specified values.

set

public VkSamplerReductionModeCreateInfo set(VkSamplerReductionModeCreateInfo src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static VkSamplerReductionModeCreateInfo malloc()

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

calloc

public static VkSamplerReductionModeCreateInfo calloc()

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

create

public static VkSamplerReductionModeCreateInfo create()

Returns a new VkSamplerReductionModeCreateInfo instance allocated with BufferUtils.

create

public static VkSamplerReductionModeCreateInfo create(long address)

Returns a new VkSamplerReductionModeCreateInfo instance for the specified memory address.

createSafe

public static @Nullable VkSamplerReductionModeCreateInfo createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VkSamplerReductionModeCreateInfo.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static VkSamplerReductionModeCreateInfo.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static VkSamplerReductionModeCreateInfo.Buffer create(int capacity)

Returns a new VkSamplerReductionModeCreateInfo.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a VkSamplerReductionModeCreateInfo.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

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

Returns a new VkSamplerReductionModeCreateInfo instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

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

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

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

nreductionMode

public static int nreductionMode(long struct)

Unsafe version of reductionMode().

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.

nreductionMode

public static void nreductionMode(long struct,
 int value)

Unsafe version of reductionMode.