Package org.lwjgl.vulkan

Class VkPipelineRasterizationLineStateCreateInfoEXT

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct

org.lwjgl.vulkan.VkPipelineRasterizationLineStateCreateInfoEXT

All Implemented Interfaces:

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

public class VkPipelineRasterizationLineStateCreateInfoEXT
extends org.lwjgl.system.Struct
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_EXT, then the rectangularLines feature must be enabled
• If lineRasterizationMode is LINE_RASTERIZATION_MODE_BRESENHAM_EXT, then the bresenhamLines feature must be enabled
• If lineRasterizationMode is LINE_RASTERIZATION_MODE_RECTANGULAR_SMOOTH_EXT, then the smoothLines feature must be enabled
• If stippledLineEnable is TRUE and lineRasterizationMode is LINE_RASTERIZATION_MODE_RECTANGULAR_EXT, then the stippledRectangularLines feature must be enabled
• If stippledLineEnable is TRUE and lineRasterizationMode is LINE_RASTERIZATION_MODE_BRESENHAM_EXT, then the stippledBresenhamLines feature must be enabled
• If stippledLineEnable is TRUE and lineRasterizationMode is LINE_RASTERIZATION_MODE_RECTANGULAR_SMOOTH_EXT, then the stippledSmoothLines feature must be enabled
• If stippledLineEnable is TRUE and lineRasterizationMode is LINE_RASTERIZATION_MODE_DEFAULT_EXT, 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_EXT
• lineRasterizationMode must be a valid VkLineRasterizationModeEXT value

Layout

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

Nested Class Summary

Nested Classes

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

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

org.lwjgl.system.Pointer.Default

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

org.lwjgl.system.Struct.StructValidation

Field Summary

Fields

Modifier and Type	Field	Description
static int	ALIGNOF	The struct alignment in bytes.
static int	LINERASTERIZATIONMODE LINESTIPPLEFACTOR LINESTIPPLEPATTERN PNEXT	The struct member offsets.
static int	SIZEOF	The struct size in bytes.
static int	STIPPLEDLINEENABLE 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
VkPipelineRasterizationLineStateCreateInfoEXT(java.nio.ByteBuffer container)	Creates a VkPipelineRasterizationLineStateCreateInfoEXT instance at the current position of the specified ByteBuffer container.

Method Summary

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

Methods inherited from interface org.lwjgl.system.NativeResource

close, free

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

address, equals, hashCode, toString

Methods inherited from class org.lwjgl.system.Struct

clear, free, isNull, validate

Field Detail

SIZEOF

The struct size in bytes.

ALIGNOF

The struct alignment in bytes.

STYPE, PNEXT, LINERASTERIZATIONMODE, STIPPLEDLINEENABLE, LINESTIPPLEFACTOR, LINESTIPPLEPATTERN

The struct member offsets.

Constructor Detail

VkPipelineRasterizationLineStateCreateInfoEXT

public VkPipelineRasterizationLineStateCreateInfoEXT(java.nio.ByteBuffer container)

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

sizeof

public int sizeof()

Specified by:

sizeof in class org.lwjgl.system.Struct

sType

public int sType()

the type of this structure.

pNext

public long pNext()

NULL or a pointer to a structure extending this structure.

lineRasterizationMode

public int lineRasterizationMode()

a VkLineRasterizationModeEXT 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 VkPipelineRasterizationLineStateCreateInfoEXT sType(int value)

Sets the specified value to the sType() field.

sType$Default

public VkPipelineRasterizationLineStateCreateInfoEXT sType$Default()

Sets the STRUCTURE_TYPE_PIPELINE_RASTERIZATION_LINE_STATE_CREATE_INFO_EXT value to the sType() field.

pNext

public VkPipelineRasterizationLineStateCreateInfoEXT pNext(long value)

Sets the specified value to the pNext() field.

lineRasterizationMode

public VkPipelineRasterizationLineStateCreateInfoEXT lineRasterizationMode(int value)

Sets the specified value to the lineRasterizationMode() field.

stippledLineEnable

public VkPipelineRasterizationLineStateCreateInfoEXT stippledLineEnable(boolean value)

Sets the specified value to the stippledLineEnable() field.

lineStippleFactor

public VkPipelineRasterizationLineStateCreateInfoEXT lineStippleFactor(int value)

Sets the specified value to the lineStippleFactor() field.

lineStipplePattern

public VkPipelineRasterizationLineStateCreateInfoEXT lineStipplePattern(short value)

Sets the specified value to the lineStipplePattern() field.

set

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

Initializes this struct with the specified values.

set

public VkPipelineRasterizationLineStateCreateInfoEXT set(VkPipelineRasterizationLineStateCreateInfoEXT src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static VkPipelineRasterizationLineStateCreateInfoEXT malloc()

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

calloc

public static VkPipelineRasterizationLineStateCreateInfoEXT calloc()

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

create

public static VkPipelineRasterizationLineStateCreateInfoEXT create()

Returns a new VkPipelineRasterizationLineStateCreateInfoEXT instance allocated with BufferUtils.

create

public static VkPipelineRasterizationLineStateCreateInfoEXT create(long address)

Returns a new VkPipelineRasterizationLineStateCreateInfoEXT instance for the specified memory address.

createSafe

@Nullable
public static VkPipelineRasterizationLineStateCreateInfoEXT createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VkPipelineRasterizationLineStateCreateInfoEXT.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static VkPipelineRasterizationLineStateCreateInfoEXT.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static VkPipelineRasterizationLineStateCreateInfoEXT.Buffer create(int capacity)

Returns a new VkPipelineRasterizationLineStateCreateInfoEXT.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a VkPipelineRasterizationLineStateCreateInfoEXT.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

mallocStack

@Deprecated
public static VkPipelineRasterizationLineStateCreateInfoEXT mallocStack()

Deprecated.

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

callocStack

@Deprecated
public static VkPipelineRasterizationLineStateCreateInfoEXT callocStack()

Deprecated.

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

mallocStack

@Deprecated
public static VkPipelineRasterizationLineStateCreateInfoEXT mallocStack(org.lwjgl.system.MemoryStack stack)

Deprecated.

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

callocStack

@Deprecated
public static VkPipelineRasterizationLineStateCreateInfoEXT callocStack(org.lwjgl.system.MemoryStack stack)

Deprecated.

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

mallocStack

@Deprecated
public static VkPipelineRasterizationLineStateCreateInfoEXT.Buffer mallocStack(int capacity)

Deprecated.

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

callocStack

@Deprecated
public static VkPipelineRasterizationLineStateCreateInfoEXT.Buffer callocStack(int capacity)

Deprecated.

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

mallocStack

@Deprecated
public static VkPipelineRasterizationLineStateCreateInfoEXT.Buffer mallocStack(int capacity,
                                                                               org.lwjgl.system.MemoryStack stack)

Deprecated.

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

callocStack

@Deprecated
public static VkPipelineRasterizationLineStateCreateInfoEXT.Buffer callocStack(int capacity,
                                                                               org.lwjgl.system.MemoryStack stack)

Deprecated.

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

malloc

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

Returns a new VkPipelineRasterizationLineStateCreateInfoEXT instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

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

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

stack - the stack from which to allocate

capacity - the buffer capacity

calloc

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

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

Parameters:

stack - the stack from which to allocate

capacity - the buffer capacity

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.