Top Description Inners Fields Constructors Methods
org.lwjgl.vulkan

public Class VkStencilOpState

extends Struct<VkStencilOpState>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable
Imports
javax.annotation.*, java.nio.*, org.lwjgl.*, org.lwjgl.system.*

Structure specifying stencil operation state.
Valid Usage (Implicit)
See Also

VkPipelineDepthStencilStateCreateInfo

Layout


struct VkStencilOpState {
    VkStencilOp failOp;
    VkStencilOp passOp;
    VkStencilOp depthFailOp;
    VkCompareOp compareOp;
    uint32_t compareMask;
    uint32_t writeMask;
    uint32_t reference;
}

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
COMPAREMASK

The struct member offsets.

public static final int
COMPAREOP

The struct member offsets.

public static final int
DEPTHFAILOP

The struct member offsets.

public static final int
FAILOP

The struct member offsets.

public static final int
PASSOP

The struct member offsets.

public static final int
REFERENCE

The struct member offsets.

public static final int
SIZEOF

The struct size in bytes.

public static final int
WRITEMASK

The struct member offsets.

Inherited from org.lwjgl.system.Struct:
containerDEFAULT_ALIGN_ASDEFAULT_PACK_ALIGNMENT

Constructor Summary

AccessConstructor and Description
protected
VkStencilOpState(long address, ByteBuffer container)

public
VkStencilOpState(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public static VkStencilOpState
calloc()

Returns a new VkStencilOpState instance allocated with memCalloc.

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

Returns a new VkStencilOpState.Buffer instance allocated with memCalloc.

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

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

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

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

public static VkStencilOpState
callocStack()

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

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

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

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

selects the bits of the unsigned integer stencil values participating in the stencil test.

public VkStencilOpState
compareMask(int value)

Sets the specified value to the compareMask field.

public int
compareOp()

a VkCompareOp value specifying the comparison operator used in the stencil test.

public VkStencilOpState
compareOp(int value)

Sets the specified value to the compareOp field.

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

Returns a new VkStencilOpState instance allocated with BufferUtils.

public static VkStencilOpState
create(long address)

Returns a new VkStencilOpState instance for the specified memory address.

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

Returns a new VkStencilOpState.Buffer instance allocated with BufferUtils.

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

Create a VkStencilOpState.Buffer instance at the specified memory.

public static VkStencilOpState
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public int
depthFailOp()

a VkStencilOp value specifying the action performed on samples that pass the stencil test and fail the depth test.

public VkStencilOpState
depthFailOp(int value)

Sets the specified value to the depthFailOp field.

public int
failOp()

a VkStencilOp value specifying the action performed on samples that fail the stencil test.

public VkStencilOpState
failOp(int value)

Sets the specified value to the failOp field.

public static VkStencilOpState
malloc()

Returns a new VkStencilOpState instance allocated with memAlloc.

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

Returns a new VkStencilOpState.Buffer instance allocated with memAlloc.

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

Returns a new VkStencilOpState instance allocated on the specified MemoryStack.

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

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

public static VkStencilOpState
mallocStack()

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

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

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

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

Unsafe version of compareMask.

public static void
ncompareMask(long struct, int value)

Unsafe version of compareMask.

public static int
ncompareOp(long struct)

Unsafe version of compareOp.

public static void
ncompareOp(long struct, int value)

Unsafe version of compareOp.

public static int
ndepthFailOp(long struct)

Unsafe version of depthFailOp.

public static void
ndepthFailOp(long struct, int value)

Unsafe version of depthFailOp.

public static int
nfailOp(long struct)

Unsafe version of failOp.

public static void
nfailOp(long struct, int value)

Unsafe version of failOp.

public static int
npassOp(long struct)

Unsafe version of passOp.

public static void
npassOp(long struct, int value)

Unsafe version of passOp.

public static int
nreference(long struct)

Unsafe version of reference.

public static void
nreference(long struct, int value)

Unsafe version of reference.

public static int
nwriteMask(long struct)

Unsafe version of writeMask.

public static void
nwriteMask(long struct, int value)

Unsafe version of writeMask.

public int
passOp()

a VkStencilOp value specifying the action performed on samples that pass both the depth and stencil tests.

public VkStencilOpState
passOp(int value)

Sets the specified value to the passOp field.

public int
reference()

an integer stencil reference value that is used in the unsigned stencil comparison.

public VkStencilOpState
reference(int value)

Sets the specified value to the reference field.

public VkStencilOpState
set(int failOp, int passOp, int depthFailOp, int compareOp, int compareMask, int writeMask, int reference)

Initializes this struct with the specified values.

public VkStencilOpState

Returns:

this struct
set
(VkStencilOpState
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
writeMask()

selects the bits of the unsigned integer stencil values updated by the stencil test in the stencil framebuffer attachment.

public VkStencilOpState
writeMask(int value)

Sets the specified value to the writeMask 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.

COMPAREMASKback to summary
public static final int COMPAREMASK

The struct member offsets.

COMPAREOPback to summary
public static final int COMPAREOP

The struct member offsets.

DEPTHFAILOPback to summary
public static final int DEPTHFAILOP

The struct member offsets.

FAILOPback to summary
public static final int FAILOP

The struct member offsets.

PASSOPback to summary
public static final int PASSOP

The struct member offsets.

REFERENCEback to summary
public static final int REFERENCE

The struct member offsets.

SIZEOFback to summary
public static final int SIZEOF

The struct size in bytes.

WRITEMASKback to summary
public static final int WRITEMASK

The struct member offsets.

Constructor Detail

VkStencilOpStateback to summary
protected VkStencilOpState(long address, ByteBuffer container)
VkStencilOpStateback to summary
public VkStencilOpState(ByteBuffer container)

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

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

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

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static VkStencilOpState calloc(MemoryStack stack)

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

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

Deprecated

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

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

Deprecated

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

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

Deprecated

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

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

Deprecated

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

Annotations
@Deprecated
compareMaskback to summary
public int compareMask()

selects the bits of the unsigned integer stencil values participating in the stencil test.

Annotations
@NativeType:uint32_t
compareMaskback to summary
public VkStencilOpState compareMask(int value)

Sets the specified value to the compareMask field.

compareOpback to summary
public int compareOp()

a VkCompareOp value specifying the comparison operator used in the stencil test.

Annotations
@NativeType:VkCompareOp
compareOpback to summary
public VkStencilOpState compareOp(int value)

Sets the specified value to the compareOp field.

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

Returns a new VkStencilOpState instance allocated with BufferUtils.

createback to summary
public static VkStencilOpState create(long address)

Returns a new VkStencilOpState instance for the specified memory address.

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

Returns a new VkStencilOpState.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a VkStencilOpState.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static VkStencilOpState createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

Annotations
@Nullable
depthFailOpback to summary
public int depthFailOp()

a VkStencilOp value specifying the action performed on samples that pass the stencil test and fail the depth test.

Annotations
@NativeType:VkStencilOp
depthFailOpback to summary
public VkStencilOpState depthFailOp(int value)

Sets the specified value to the depthFailOp field.

failOpback to summary
public int failOp()

a VkStencilOp value specifying the action performed on samples that fail the stencil test.

Annotations
@NativeType:VkStencilOp
failOpback to summary
public VkStencilOpState failOp(int value)

Sets the specified value to the failOp field.

mallocback to summary
public static VkStencilOpState malloc()

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

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

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static VkStencilOpState malloc(MemoryStack stack)

Returns a new VkStencilOpState instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

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

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

Deprecated

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

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

Deprecated

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

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

Deprecated

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

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

Deprecated

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

Annotations
@Deprecated
ncompareMaskback to summary
public static int ncompareMask(long struct)

Unsafe version of compareMask.

ncompareMaskback to summary
public static void ncompareMask(long struct, int value)

Unsafe version of compareMask.

ncompareOpback to summary
public static int ncompareOp(long struct)

Unsafe version of compareOp.

ncompareOpback to summary
public static void ncompareOp(long struct, int value)

Unsafe version of compareOp.

ndepthFailOpback to summary
public static int ndepthFailOp(long struct)

Unsafe version of depthFailOp.

ndepthFailOpback to summary
public static void ndepthFailOp(long struct, int value)

Unsafe version of depthFailOp.

nfailOpback to summary
public static int nfailOp(long struct)

Unsafe version of failOp.

nfailOpback to summary
public static void nfailOp(long struct, int value)

Unsafe version of failOp.

npassOpback to summary
public static int npassOp(long struct)

Unsafe version of passOp.

npassOpback to summary
public static void npassOp(long struct, int value)

Unsafe version of passOp.

nreferenceback to summary
public static int nreference(long struct)

Unsafe version of reference.

nreferenceback to summary
public static void nreference(long struct, int value)

Unsafe version of reference.

nwriteMaskback to summary
public static int nwriteMask(long struct)

Unsafe version of writeMask.

nwriteMaskback to summary
public static void nwriteMask(long struct, int value)

Unsafe version of writeMask.

passOpback to summary
public int passOp()

a VkStencilOp value specifying the action performed on samples that pass both the depth and stencil tests.

Annotations
@NativeType:VkStencilOp
passOpback to summary
public VkStencilOpState passOp(int value)

Sets the specified value to the passOp field.

referenceback to summary
public int reference()

an integer stencil reference value that is used in the unsigned stencil comparison.

Annotations
@NativeType:uint32_t
referenceback to summary
public VkStencilOpState reference(int value)

Sets the specified value to the reference field.

setback to summary
public VkStencilOpState set(int failOp, int passOp, int depthFailOp, int compareOp, int compareMask, int writeMask, int reference)

Initializes this struct with the specified values.

setback to summary
public VkStencilOpState set(VkStencilOpState src)

Copies the specified struct data to this struct.

Parameters
src:VkStencilOpState

the source struct

Returns:VkStencilOpState

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
writeMaskback to summary
public int writeMask()

selects the bits of the unsigned integer stencil values updated by the stencil test in the stencil framebuffer attachment.

Annotations
@NativeType:uint32_t
writeMaskback to summary
public VkStencilOpState writeMask(int value)

Sets the specified value to the writeMask field.

org.lwjgl.vulkan back to summary

public Class VkStencilOpState.Buffer

extends StructBuffer<VkStencilOpState, VkStencilOpState.Buffer>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable

An array of VkStencilOpState structs.

Field Summary

Modifier and TypeField and Description
private static final VkStencilOpState

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new VkStencilOpState.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 VkStencilOpState#compareMask field.
compareMask
()

public VkStencilOpState.Buffer
compareMask(int value)

Sets the specified value to the VkStencilOpState#compareMask field.

public int

Returns:

the value of the VkStencilOpState#compareOp field.
compareOp
()

public VkStencilOpState.Buffer
compareOp(int value)

Sets the specified value to the VkStencilOpState#compareOp field.

public int

Returns:

the value of the VkStencilOpState#depthFailOp field.
depthFailOp
()

public VkStencilOpState.Buffer
depthFailOp(int value)

Sets the specified value to the VkStencilOpState#depthFailOp field.

public int

Returns:

the value of the VkStencilOpState#failOp field.
failOp
()

public VkStencilOpState.Buffer
failOp(int value)

Sets the specified value to the VkStencilOpState#failOp field.

protected VkStencilOpState
public int

Returns:

the value of the VkStencilOpState#passOp field.
passOp
()

public VkStencilOpState.Buffer
passOp(int value)

Sets the specified value to the VkStencilOpState#passOp field.

public int

Returns:

the value of the VkStencilOpState#reference field.
reference
()

public VkStencilOpState.Buffer
reference(int value)

Sets the specified value to the VkStencilOpState#reference field.

protected VkStencilOpState.Buffer
public int

Returns:

the value of the VkStencilOpState#writeMask field.
writeMask
()

public VkStencilOpState.Buffer
writeMask(int value)

Sets the specified value to the VkStencilOpState#writeMask field.

Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final VkStencilOpState ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

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

compareMaskback to summary
public int compareMask()
Returns:int

the value of the VkStencilOpState#compareMask field.

Annotations
@NativeType:uint32_t
compareMaskback to summary
public VkStencilOpState.Buffer compareMask(int value)

Sets the specified value to the VkStencilOpState#compareMask field.

compareOpback to summary
public int compareOp()
Returns:int

the value of the VkStencilOpState#compareOp field.

Annotations
@NativeType:VkCompareOp
compareOpback to summary
public VkStencilOpState.Buffer compareOp(int value)

Sets the specified value to the VkStencilOpState#compareOp field.

depthFailOpback to summary
public int depthFailOp()
Returns:int

the value of the VkStencilOpState#depthFailOp field.

Annotations
@NativeType:VkStencilOp
depthFailOpback to summary
public VkStencilOpState.Buffer depthFailOp(int value)

Sets the specified value to the VkStencilOpState#depthFailOp field.

failOpback to summary
public int failOp()
Returns:int

the value of the VkStencilOpState#failOp field.

Annotations
@NativeType:VkStencilOp
failOpback to summary
public VkStencilOpState.Buffer failOp(int value)

Sets the specified value to the VkStencilOpState#failOp field.

getElementFactoryback to summary
protected VkStencilOpState getElementFactory()

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

Annotations
@Override
passOpback to summary
public int passOp()
Returns:int

the value of the VkStencilOpState#passOp field.

Annotations
@NativeType:VkStencilOp
passOpback to summary
public VkStencilOpState.Buffer passOp(int value)

Sets the specified value to the VkStencilOpState#passOp field.

referenceback to summary
public int reference()
Returns:int

the value of the VkStencilOpState#reference field.

Annotations
@NativeType:uint32_t
referenceback to summary
public VkStencilOpState.Buffer reference(int value)

Sets the specified value to the VkStencilOpState#reference field.

selfback to summary
protected VkStencilOpState.Buffer self()

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

Annotations
@Override
writeMaskback to summary
public int writeMask()
Returns:int

the value of the VkStencilOpState#writeMask field.

Annotations
@NativeType:uint32_t
writeMaskback to summary
public VkStencilOpState.Buffer writeMask(int value)

Sets the specified value to the VkStencilOpState#writeMask field.