Top Description Inners Fields Constructors Methods
org.lwjgl.vulkan

public Class VkSamplerReductionModeCreateInfo

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

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)

Layout


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

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
PNEXT

The struct member offsets.

public static final int
REDUCTIONMODE

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
public
VkSamplerReductionModeCreateInfo(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public static VkSamplerReductionModeCreateInfo
calloc()

Returns a new VkSamplerReductionModeCreateInfo instance allocated with memCalloc.

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

Returns a new VkSamplerReductionModeCreateInfo.Buffer instance allocated with memCalloc.

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

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

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

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

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

Returns a new VkSamplerReductionModeCreateInfo instance allocated with BufferUtils.

public static VkSamplerReductionModeCreateInfo
create(long address)

Returns a new VkSamplerReductionModeCreateInfo instance for the specified memory address.

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

Returns a new VkSamplerReductionModeCreateInfo.Buffer instance allocated with BufferUtils.

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

Create a VkSamplerReductionModeCreateInfo.Buffer instance at the specified memory.

public static VkSamplerReductionModeCreateInfo
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public static VkSamplerReductionModeCreateInfo
malloc()

Returns a new VkSamplerReductionModeCreateInfo instance allocated with memAlloc.

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

Returns a new VkSamplerReductionModeCreateInfo.Buffer instance allocated with memAlloc.

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

Returns a new VkSamplerReductionModeCreateInfo instance allocated on the specified MemoryStack.

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

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

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
nreductionMode(long struct)

Unsafe version of reductionMode.

public static void
nreductionMode(long struct, int value)

Unsafe version of reductionMode.

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

Sets the specified value to the pNext field.

public int
reductionMode()

a VkSamplerReductionMode value controlling how texture filtering combines texel values.

public VkSamplerReductionModeCreateInfo
reductionMode(int value)

Sets the specified value to the reductionMode field.

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

Initializes this struct with the specified values.

public VkSamplerReductionModeCreateInfo

Returns:

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

Sets the specified value to the sType field.

public VkSamplerReductionModeCreateInfo
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.

PNEXTback to summary
public static final int PNEXT

The struct member offsets.

REDUCTIONMODEback to summary
public static final int REDUCTIONMODE

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

VkSamplerReductionModeCreateInfoback to summary
protected VkSamplerReductionModeCreateInfo(long address, ByteBuffer container)
VkSamplerReductionModeCreateInfoback to summary
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 Detail

callocback to summary
public static VkSamplerReductionModeCreateInfo calloc()

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

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

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static VkSamplerReductionModeCreateInfo calloc(MemoryStack stack)

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

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

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

Returns a new VkSamplerReductionModeCreateInfo instance allocated with BufferUtils.

createback to summary
public static VkSamplerReductionModeCreateInfo create(long address)

Returns a new VkSamplerReductionModeCreateInfo instance for the specified memory address.

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

Returns a new VkSamplerReductionModeCreateInfo.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a VkSamplerReductionModeCreateInfo.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static VkSamplerReductionModeCreateInfo createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

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

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

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

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static VkSamplerReductionModeCreateInfo malloc(MemoryStack stack)

Returns a new VkSamplerReductionModeCreateInfo instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

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

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

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

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.

nreductionModeback to summary
public static int nreductionMode(long struct)

Unsafe version of reductionMode.

nreductionModeback to summary
public static void nreductionMode(long struct, int value)

Unsafe version of reductionMode.

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 const *
pNextback to summary
public VkSamplerReductionModeCreateInfo pNext(long value)

Sets the specified value to the pNext field.

reductionModeback to summary
public int reductionMode()

a VkSamplerReductionMode value controlling how texture filtering combines texel values.

Annotations
@NativeType:VkSamplerReductionMode
reductionModeback to summary
public VkSamplerReductionModeCreateInfo reductionMode(int value)

Sets the specified value to the reductionMode field.

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

Initializes this struct with the specified values.

setback to summary
public VkSamplerReductionModeCreateInfo set(VkSamplerReductionModeCreateInfo src)

Copies the specified struct data to this struct.

Parameters
src:VkSamplerReductionModeCreateInfo

the source struct

Returns:VkSamplerReductionModeCreateInfo

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

Sets the specified value to the sType field.

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

Sets the STRUCTURE_TYPE_SAMPLER_REDUCTION_MODE_CREATE_INFO value to the sType field.

org.lwjgl.vulkan back to summary

public Class VkSamplerReductionModeCreateInfo.Buffer

extends StructBuffer<VkSamplerReductionModeCreateInfo, VkSamplerReductionModeCreateInfo.Buffer>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable
Known Direct Subclasses
org.lwjgl.vulkan.VkSamplerReductionModeCreateInfoEXT.Buffer

An array of VkSamplerReductionModeCreateInfo structs.

Field Summary

Modifier and TypeField and Description
private static final VkSamplerReductionModeCreateInfo

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new VkSamplerReductionModeCreateInfo.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
protected VkSamplerReductionModeCreateInfo
public long

Returns:

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

public VkSamplerReductionModeCreateInfo.Buffer
pNext(long value)

Sets the specified value to the VkSamplerReductionModeCreateInfo#pNext field.

public int
public VkSamplerReductionModeCreateInfo.Buffer
reductionMode(int value)

Sets the specified value to the VkSamplerReductionModeCreateInfo#reductionMode field.

protected VkSamplerReductionModeCreateInfo.Buffer
public int

Returns:

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

public VkSamplerReductionModeCreateInfo.Buffer
sType(int value)

Sets the specified value to the VkSamplerReductionModeCreateInfo#sType field.

public VkSamplerReductionModeCreateInfo.Buffer
Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final VkSamplerReductionModeCreateInfo ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

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

getElementFactoryback to summary
protected VkSamplerReductionModeCreateInfo getElementFactory()

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

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

the value of the VkSamplerReductionModeCreateInfo#pNext field.

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

Sets the specified value to the VkSamplerReductionModeCreateInfo#pNext field.

reductionModeback to summary
public int reductionMode()
Returns:int

the value of the VkSamplerReductionModeCreateInfo#reductionMode field.

Annotations
@NativeType:VkSamplerReductionMode
reductionModeback to summary
public VkSamplerReductionModeCreateInfo.Buffer reductionMode(int value)

Sets the specified value to the VkSamplerReductionModeCreateInfo#reductionMode field.

selfback to summary
protected VkSamplerReductionModeCreateInfo.Buffer self()

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

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

the value of the VkSamplerReductionModeCreateInfo#sType field.

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

Sets the specified value to the VkSamplerReductionModeCreateInfo#sType field.

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

Sets the STRUCTURE_TYPE_SAMPLER_REDUCTION_MODE_CREATE_INFO value to the VkSamplerReductionModeCreateInfo#sType field.