Package org.lwjgl.vulkan

Class VkPipelineRasterizationLineStateCreateInfo

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkPipelineRasterizationLineStateCreateInfo>

org.lwjgl.vulkan.VkPipelineRasterizationLineStateCreateInfo

All Implemented Interfaces:

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

Direct Known Subclasses:

VkPipelineRasterizationLineStateCreateInfoEXT, VkPipelineRasterizationLineStateCreateInfoKHR

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

Structure specifying parameters of a newly created pipeline line rasterization state.

Description

If stippledLineEnable is FALSE, the values of lineStippleFactor and lineStipplePattern are ignored.

Valid Usage

• If lineRasterizationMode is LINE_RASTERIZATION_MODE_RECTANGULAR, then the rectangularLines feature must be enabled
• If lineRasterizationMode is LINE_RASTERIZATION_MODE_BRESENHAM, then the bresenhamLines feature must be enabled
• If lineRasterizationMode is LINE_RASTERIZATION_MODE_RECTANGULAR_SMOOTH, then the smoothLines feature must be enabled
• If stippledLineEnable is TRUE and lineRasterizationMode is LINE_RASTERIZATION_MODE_RECTANGULAR, then the stippledRectangularLines feature must be enabled
• If stippledLineEnable is TRUE and lineRasterizationMode is LINE_RASTERIZATION_MODE_BRESENHAM, then the stippledBresenhamLines feature must be enabled
• If stippledLineEnable is TRUE and lineRasterizationMode is LINE_RASTERIZATION_MODE_RECTANGULAR_SMOOTH, then the stippledSmoothLines feature must be enabled
• If stippledLineEnable is TRUE and lineRasterizationMode is LINE_RASTERIZATION_MODE_DEFAULT, then the stippledRectangularLines feature must be enabled and VkPhysicalDeviceLimits::strictLines must be TRUE

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_PIPELINE_RASTERIZATION_LINE_STATE_CREATE_INFO
• lineRasterizationMode must be a valid VkLineRasterizationMode value

Layout

 struct VkPipelineRasterizationLineStateCreateInfo {
     VkStructureType sType();
     void const * pNext();
     VkLineRasterizationMode lineRasterizationMode();
     VkBool32 stippledLineEnable();
     uint32_t lineStippleFactor();
     uint16_t lineStipplePattern();
 }

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	VkPipelineRasterizationLineStateCreateInfo.Buffer	An array of VkPipelineRasterizationLineStateCreateInfo 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	LINERASTERIZATIONMODE	The struct member offsets.
static final int	LINESTIPPLEFACTOR	The struct member offsets.
static final int	LINESTIPPLEPATTERN	The struct member offsets.
static final int	PNEXT	The struct member offsets.
static final int	SIZEOF	The struct size in bytes.
static final int	STIPPLEDLINEENABLE	The struct member offsets.
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
VkPipelineRasterizationLineStateCreateInfo(ByteBuffer container)	Creates a VkPipelineRasterizationLineStateCreateInfo instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and Type	Method	Description
static VkPipelineRasterizationLineStateCreateInfo	calloc()	Returns a new VkPipelineRasterizationLineStateCreateInfo instance allocated with memCalloc.
static VkPipelineRasterizationLineStateCreateInfo.Buffer	calloc(int capacity)	Returns a new VkPipelineRasterizationLineStateCreateInfo.Buffer instance allocated with memCalloc.
static VkPipelineRasterizationLineStateCreateInfo.Buffer	calloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkPipelineRasterizationLineStateCreateInfo.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkPipelineRasterizationLineStateCreateInfo	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkPipelineRasterizationLineStateCreateInfo instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkPipelineRasterizationLineStateCreateInfo	create()	Returns a new VkPipelineRasterizationLineStateCreateInfo instance allocated with BufferUtils.
static VkPipelineRasterizationLineStateCreateInfo.Buffer	create(int capacity)	Returns a new VkPipelineRasterizationLineStateCreateInfo.Buffer instance allocated with BufferUtils.
static VkPipelineRasterizationLineStateCreateInfo	create(long address)	Returns a new VkPipelineRasterizationLineStateCreateInfo instance for the specified memory address.
static VkPipelineRasterizationLineStateCreateInfo.Buffer	create(long address, int capacity)	Create a VkPipelineRasterizationLineStateCreateInfo.Buffer instance at the specified memory.
static @Nullable VkPipelineRasterizationLineStateCreateInfo	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable VkPipelineRasterizationLineStateCreateInfo.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
int	lineRasterizationMode()	a VkLineRasterizationMode value selecting the style of line rasterization.
VkPipelineRasterizationLineStateCreateInfo	lineRasterizationMode(int value)	Sets the specified value to the lineRasterizationMode() field.
int	lineStippleFactor()	the repeat factor used in stippled line rasterization.
VkPipelineRasterizationLineStateCreateInfo	lineStippleFactor(int value)	Sets the specified value to the lineStippleFactor() field.
short	lineStipplePattern()	the bit pattern used in stippled line rasterization.
VkPipelineRasterizationLineStateCreateInfo	lineStipplePattern(short value)	Sets the specified value to the lineStipplePattern() field.
static VkPipelineRasterizationLineStateCreateInfo	malloc()	Returns a new VkPipelineRasterizationLineStateCreateInfo instance allocated with memAlloc.
static VkPipelineRasterizationLineStateCreateInfo.Buffer	malloc(int capacity)	Returns a new VkPipelineRasterizationLineStateCreateInfo.Buffer instance allocated with memAlloc.
static VkPipelineRasterizationLineStateCreateInfo.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkPipelineRasterizationLineStateCreateInfo.Buffer instance allocated on the specified MemoryStack.
static VkPipelineRasterizationLineStateCreateInfo	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkPipelineRasterizationLineStateCreateInfo instance allocated on the specified MemoryStack.
static int	nlineRasterizationMode(long struct)	Unsafe version of lineRasterizationMode().
static void	nlineRasterizationMode(long struct, int value)	Unsafe version of lineRasterizationMode.
static int	nlineStippleFactor(long struct)	Unsafe version of lineStippleFactor().
static void	nlineStippleFactor(long struct, int value)	Unsafe version of lineStippleFactor.
static short	nlineStipplePattern(long struct)	Unsafe version of lineStipplePattern().
static void	nlineStipplePattern(long struct, short value)	Unsafe version of lineStipplePattern.
static long	npNext(long struct)	Unsafe version of pNext().
static void	npNext(long struct, long value)	Unsafe version of pNext.
static int	nstippledLineEnable(long struct)	Unsafe version of stippledLineEnable().
static void	nstippledLineEnable(long struct, int value)	Unsafe version of stippledLineEnable.
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.
VkPipelineRasterizationLineStateCreateInfo	pNext(long value)	Sets the specified value to the pNext() field.
VkPipelineRasterizationLineStateCreateInfo	set(int sType, long pNext, int lineRasterizationMode, boolean stippledLineEnable, int lineStippleFactor, short lineStipplePattern)	Initializes this struct with the specified values.
VkPipelineRasterizationLineStateCreateInfo	set(VkPipelineRasterizationLineStateCreateInfo src)	Copies the specified struct data to this struct.
int	sizeof()
boolean	stippledLineEnable()	enables stippled line rasterization.
VkPipelineRasterizationLineStateCreateInfo	stippledLineEnable(boolean value)	Sets the specified value to the stippledLineEnable() field.
int	sType()	a VkStructureType value identifying this structure.
VkPipelineRasterizationLineStateCreateInfo	sType(int value)	Sets the specified value to the sType() field.
VkPipelineRasterizationLineStateCreateInfo	sType$Default()	Sets the STRUCTURE_TYPE_PIPELINE_RASTERIZATION_LINE_STATE_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.

LINERASTERIZATIONMODE

public static final int LINERASTERIZATIONMODE

The struct member offsets.

STIPPLEDLINEENABLE

public static final int STIPPLEDLINEENABLE

The struct member offsets.

LINESTIPPLEFACTOR

public static final int LINESTIPPLEFACTOR

The struct member offsets.

LINESTIPPLEPATTERN

public static final int LINESTIPPLEPATTERN

The struct member offsets.

Constructor Details

VkPipelineRasterizationLineStateCreateInfo

public VkPipelineRasterizationLineStateCreateInfo(ByteBuffer container)

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

sType

public int sType()

a VkStructureType value identifying this structure.

pNext

public long pNext()

NULL or a pointer to a structure extending this structure.

lineRasterizationMode

public int lineRasterizationMode()

a VkLineRasterizationMode value selecting the style of line rasterization.

stippledLineEnable

public boolean stippledLineEnable()

enables stippled line rasterization.

lineStippleFactor

public int lineStippleFactor()

the repeat factor used in stippled line rasterization.

lineStipplePattern

public short lineStipplePattern()

the bit pattern used in stippled line rasterization.

sType

public VkPipelineRasterizationLineStateCreateInfo sType(int value)

Sets the specified value to the sType() field.

sType$Default

public VkPipelineRasterizationLineStateCreateInfo sType$Default()

Sets the STRUCTURE_TYPE_PIPELINE_RASTERIZATION_LINE_STATE_CREATE_INFO value to the sType() field.

pNext

public VkPipelineRasterizationLineStateCreateInfo pNext(long value)

Sets the specified value to the pNext() field.

lineRasterizationMode

public VkPipelineRasterizationLineStateCreateInfo lineRasterizationMode(int value)

Sets the specified value to the lineRasterizationMode() field.

stippledLineEnable

public VkPipelineRasterizationLineStateCreateInfo stippledLineEnable(boolean value)

Sets the specified value to the stippledLineEnable() field.

lineStippleFactor

public VkPipelineRasterizationLineStateCreateInfo lineStippleFactor(int value)

Sets the specified value to the lineStippleFactor() field.

lineStipplePattern

public VkPipelineRasterizationLineStateCreateInfo lineStipplePattern(short value)

Sets the specified value to the lineStipplePattern() field.

set

public VkPipelineRasterizationLineStateCreateInfo set(int sType,
 long pNext,
 int lineRasterizationMode,
 boolean stippledLineEnable,
 int lineStippleFactor,
 short lineStipplePattern)

Initializes this struct with the specified values.

set

public VkPipelineRasterizationLineStateCreateInfo set(VkPipelineRasterizationLineStateCreateInfo src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static VkPipelineRasterizationLineStateCreateInfo malloc()

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

calloc

public static VkPipelineRasterizationLineStateCreateInfo calloc()

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

create

public static VkPipelineRasterizationLineStateCreateInfo create()

Returns a new VkPipelineRasterizationLineStateCreateInfo instance allocated with BufferUtils.

create

public static VkPipelineRasterizationLineStateCreateInfo create(long address)

Returns a new VkPipelineRasterizationLineStateCreateInfo instance for the specified memory address.

createSafe

public static @Nullable VkPipelineRasterizationLineStateCreateInfo createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VkPipelineRasterizationLineStateCreateInfo.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static VkPipelineRasterizationLineStateCreateInfo.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static VkPipelineRasterizationLineStateCreateInfo.Buffer create(int capacity)

Returns a new VkPipelineRasterizationLineStateCreateInfo.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a VkPipelineRasterizationLineStateCreateInfo.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

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

Returns a new VkPipelineRasterizationLineStateCreateInfo instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

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

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

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

nlineRasterizationMode

public static int nlineRasterizationMode(long struct)

Unsafe version of lineRasterizationMode().

nstippledLineEnable

public static int nstippledLineEnable(long struct)

Unsafe version of stippledLineEnable().

nlineStippleFactor

public static int nlineStippleFactor(long struct)

Unsafe version of lineStippleFactor().

nlineStipplePattern

public static short nlineStipplePattern(long struct)

Unsafe version of lineStipplePattern().

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.

nlineRasterizationMode

public static void nlineRasterizationMode(long struct,
 int value)

Unsafe version of lineRasterizationMode.

nstippledLineEnable

public static void nstippledLineEnable(long struct,
 int value)

Unsafe version of stippledLineEnable.

nlineStippleFactor

public static void nlineStippleFactor(long struct,
 int value)

Unsafe version of lineStippleFactor.

nlineStipplePattern

public static void nlineStipplePattern(long struct,
 short value)

Unsafe version of lineStipplePattern.