Package org.lwjgl.vulkan
Class VkPipelineViewportStateCreateInfo
- java.lang.Object
-
- org.lwjgl.system.Pointer.Default
-
- org.lwjgl.system.Struct
-
- org.lwjgl.vulkan.VkPipelineViewportStateCreateInfo
-
- All Implemented Interfaces:
java.lang.AutoCloseable
,org.lwjgl.system.NativeResource
,org.lwjgl.system.Pointer
public class VkPipelineViewportStateCreateInfo extends org.lwjgl.system.Struct implements org.lwjgl.system.NativeResource
Structure specifying parameters of a newly created pipeline viewport state.Valid Usage
- If the multiple viewports feature is not enabled,
viewportCount
must be 1 - If the multiple viewports feature is not enabled,
scissorCount
must be 1 viewportCount
must be between 1 andVkPhysicalDeviceLimits
::maxViewports
, inclusivescissorCount
must be between 1 andVkPhysicalDeviceLimits
::maxViewports
, inclusivescissorCount
andviewportCount
must be identical- If the
viewportWScalingEnable
member of aVkPipelineViewportWScalingStateCreateInfoNV
structure chained to thepNext
chain isTRUE
, theviewportCount
member of theVkPipelineViewportWScalingStateCreateInfoNV
structure must be equal toviewportCount
Valid Usage (Implicit)
sType
must beSTRUCTURE_TYPE_PIPELINE_VIEWPORT_STATE_CREATE_INFO
- Each
pNext
member of any structure (including this one) in thepNext
chain must be eitherNULL
or a pointer to a valid instance ofVkPipelineViewportCoarseSampleOrderStateCreateInfoNV
,VkPipelineViewportExclusiveScissorStateCreateInfoNV
,VkPipelineViewportShadingRateImageStateCreateInfoNV
,VkPipelineViewportSwizzleStateCreateInfoNV
, orVkPipelineViewportWScalingStateCreateInfoNV
- Each
sType
member in thepNext
chain must be unique flags
must be 0viewportCount
must be greater than 0scissorCount
must be greater than 0
See Also
VkGraphicsPipelineCreateInfo
,VkRect2D
,VkViewport
Member documentation
sType
– the type of this structure.pNext
–NULL
or a pointer to an extension-specific structure.flags
– reserved for future use.viewportCount
– the number of viewports used by the pipeline.pViewports
– a pointer to an array ofVkViewport
structures, defining the viewport transforms. If the viewport state is dynamic, this member is ignored.scissorCount
– the number of scissors and must match the number of viewports.pScissors
– a pointer to an array ofVkRect2D
structures which define the rectangular bounds of the scissor for the corresponding viewport. If the scissor state is dynamic, this member is ignored.
Layout
struct VkPipelineViewportStateCreateInfo { VkStructureType sType; void const * pNext; VkPipelineViewportStateCreateFlags flags; uint32_t viewportCount;
VkViewport
const * pViewports; uint32_t scissorCount;VkRect2D
const * pScissors; }
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
VkPipelineViewportStateCreateInfo.Buffer
An array ofVkPipelineViewportStateCreateInfo
structs.
-
Field Summary
Fields Modifier and Type Field Description static int
ALIGNOF
The struct alignment in bytes.static int
FLAGS
PNEXT
PSCISSORS
PVIEWPORTS
SCISSORCOUNTThe struct member offsets.static int
SIZEOF
The struct size in bytes.static int
STYPE
VIEWPORTCOUNTThe struct member offsets.
-
Constructor Summary
Constructors Constructor Description VkPipelineViewportStateCreateInfo(java.nio.ByteBuffer container)
Creates aVkPipelineViewportStateCreateInfo
instance at the current position of the specifiedByteBuffer
container.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static VkPipelineViewportStateCreateInfo
calloc()
Returns a newVkPipelineViewportStateCreateInfo
instance allocated withmemCalloc
.static VkPipelineViewportStateCreateInfo.Buffer
calloc(int capacity)
Returns a newVkPipelineViewportStateCreateInfo.Buffer
instance allocated withmemCalloc
.static VkPipelineViewportStateCreateInfo
callocStack()
Returns a newVkPipelineViewportStateCreateInfo
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.static VkPipelineViewportStateCreateInfo.Buffer
callocStack(int capacity)
Returns a newVkPipelineViewportStateCreateInfo.Buffer
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.static VkPipelineViewportStateCreateInfo.Buffer
callocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newVkPipelineViewportStateCreateInfo.Buffer
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.static VkPipelineViewportStateCreateInfo
callocStack(org.lwjgl.system.MemoryStack stack)
Returns a newVkPipelineViewportStateCreateInfo
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.static VkPipelineViewportStateCreateInfo
create()
Returns a newVkPipelineViewportStateCreateInfo
instance allocated withBufferUtils
.static VkPipelineViewportStateCreateInfo.Buffer
create(int capacity)
Returns a newVkPipelineViewportStateCreateInfo.Buffer
instance allocated withBufferUtils
.static VkPipelineViewportStateCreateInfo
create(long address)
Returns a newVkPipelineViewportStateCreateInfo
instance for the specified memory address.static VkPipelineViewportStateCreateInfo.Buffer
create(long address, int capacity)
Create aVkPipelineViewportStateCreateInfo.Buffer
instance at the specified memory.static VkPipelineViewportStateCreateInfo
createSafe(long address)
static VkPipelineViewportStateCreateInfo.Buffer
createSafe(long address, int capacity)
int
flags()
Returns the value of theflags
field.VkPipelineViewportStateCreateInfo
flags(int value)
Sets the specified value to theflags
field.static VkPipelineViewportStateCreateInfo
malloc()
Returns a newVkPipelineViewportStateCreateInfo
instance allocated withmemAlloc
.static VkPipelineViewportStateCreateInfo.Buffer
malloc(int capacity)
Returns a newVkPipelineViewportStateCreateInfo.Buffer
instance allocated withmemAlloc
.static VkPipelineViewportStateCreateInfo
mallocStack()
Returns a newVkPipelineViewportStateCreateInfo
instance allocated on the thread-localMemoryStack
.static VkPipelineViewportStateCreateInfo.Buffer
mallocStack(int capacity)
Returns a newVkPipelineViewportStateCreateInfo.Buffer
instance allocated on the thread-localMemoryStack
.static VkPipelineViewportStateCreateInfo.Buffer
mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newVkPipelineViewportStateCreateInfo.Buffer
instance allocated on the specifiedMemoryStack
.static VkPipelineViewportStateCreateInfo
mallocStack(org.lwjgl.system.MemoryStack stack)
Returns a newVkPipelineViewportStateCreateInfo
instance allocated on the specifiedMemoryStack
.static int
nflags(long struct)
Unsafe version offlags()
.static void
nflags(long struct, int value)
Unsafe version offlags
.static long
npNext(long struct)
Unsafe version ofpNext()
.static void
npNext(long struct, long value)
Unsafe version ofpNext
.static VkRect2D.Buffer
npScissors(long struct)
Unsafe version ofpScissors()
.static void
npScissors(long struct, VkRect2D.Buffer value)
Unsafe version ofpScissors
.static VkViewport.Buffer
npViewports(long struct)
Unsafe version ofpViewports()
.static void
npViewports(long struct, VkViewport.Buffer value)
Unsafe version ofpViewports
.static int
nscissorCount(long struct)
Unsafe version ofscissorCount()
.static void
nscissorCount(long struct, int value)
Sets the specified value to thescissorCount
field of the specifiedstruct
.static int
nsType(long struct)
Unsafe version ofsType()
.static void
nsType(long struct, int value)
Unsafe version ofsType
.static int
nviewportCount(long struct)
Unsafe version ofviewportCount()
.static void
nviewportCount(long struct, int value)
Sets the specified value to theviewportCount
field of the specifiedstruct
.long
pNext()
Returns the value of thepNext
field.VkPipelineViewportStateCreateInfo
pNext(long value)
Sets the specified value to thepNext
field.VkRect2D.Buffer
pScissors()
Returns aVkRect2D.Buffer
view of the struct array pointed to by thepScissors
field.VkPipelineViewportStateCreateInfo
pScissors(VkRect2D.Buffer value)
Sets the address of the specifiedVkRect2D.Buffer
to thepScissors
field.VkViewport.Buffer
pViewports()
Returns aVkViewport.Buffer
view of the struct array pointed to by thepViewports
field.VkPipelineViewportStateCreateInfo
pViewports(VkViewport.Buffer value)
Sets the address of the specifiedVkViewport.Buffer
to thepViewports
field.int
scissorCount()
Returns the value of thescissorCount
field.VkPipelineViewportStateCreateInfo
scissorCount(int value)
Sets the specified value to thescissorCount
field.VkPipelineViewportStateCreateInfo
set(int sType, long pNext, int flags, int viewportCount, VkViewport.Buffer pViewports, int scissorCount, VkRect2D.Buffer pScissors)
Initializes this struct with the specified values.VkPipelineViewportStateCreateInfo
set(VkPipelineViewportStateCreateInfo src)
Copies the specified struct data to this struct.int
sizeof()
int
sType()
Returns the value of thesType
field.VkPipelineViewportStateCreateInfo
sType(int value)
Sets the specified value to thesType
field.int
viewportCount()
Returns the value of theviewportCount
field.VkPipelineViewportStateCreateInfo
viewportCount(int value)
Sets the specified value to theviewportCount
field.
-
-
-
Constructor Detail
-
VkPipelineViewportStateCreateInfo
public VkPipelineViewportStateCreateInfo(java.nio.ByteBuffer container)
Creates aVkPipelineViewportStateCreateInfo
instance at the current position of the specifiedByteBuffer
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 classorg.lwjgl.system.Struct
-
sType
public int sType()
Returns the value of thesType
field.
-
pNext
public long pNext()
Returns the value of thepNext
field.
-
flags
public int flags()
Returns the value of theflags
field.
-
viewportCount
public int viewportCount()
Returns the value of theviewportCount
field.
-
pViewports
@Nullable public VkViewport.Buffer pViewports()
Returns aVkViewport.Buffer
view of the struct array pointed to by thepViewports
field.
-
scissorCount
public int scissorCount()
Returns the value of thescissorCount
field.
-
pScissors
@Nullable public VkRect2D.Buffer pScissors()
Returns aVkRect2D.Buffer
view of the struct array pointed to by thepScissors
field.
-
sType
public VkPipelineViewportStateCreateInfo sType(int value)
Sets the specified value to thesType
field.
-
pNext
public VkPipelineViewportStateCreateInfo pNext(long value)
Sets the specified value to thepNext
field.
-
flags
public VkPipelineViewportStateCreateInfo flags(int value)
Sets the specified value to theflags
field.
-
viewportCount
public VkPipelineViewportStateCreateInfo viewportCount(int value)
Sets the specified value to theviewportCount
field.
-
pViewports
public VkPipelineViewportStateCreateInfo pViewports(@Nullable VkViewport.Buffer value)
Sets the address of the specifiedVkViewport.Buffer
to thepViewports
field.
-
scissorCount
public VkPipelineViewportStateCreateInfo scissorCount(int value)
Sets the specified value to thescissorCount
field.
-
pScissors
public VkPipelineViewportStateCreateInfo pScissors(@Nullable VkRect2D.Buffer value)
Sets the address of the specifiedVkRect2D.Buffer
to thepScissors
field.
-
set
public VkPipelineViewportStateCreateInfo set(int sType, long pNext, int flags, int viewportCount, @Nullable VkViewport.Buffer pViewports, int scissorCount, @Nullable VkRect2D.Buffer pScissors)
Initializes this struct with the specified values.
-
set
public VkPipelineViewportStateCreateInfo set(VkPipelineViewportStateCreateInfo src)
Copies the specified struct data to this struct.- Parameters:
src
- the source struct- Returns:
- this struct
-
malloc
public static VkPipelineViewportStateCreateInfo malloc()
Returns a newVkPipelineViewportStateCreateInfo
instance allocated withmemAlloc
. The instance must be explicitly freed.
-
calloc
public static VkPipelineViewportStateCreateInfo calloc()
Returns a newVkPipelineViewportStateCreateInfo
instance allocated withmemCalloc
. The instance must be explicitly freed.
-
create
public static VkPipelineViewportStateCreateInfo create()
Returns a newVkPipelineViewportStateCreateInfo
instance allocated withBufferUtils
.
-
create
public static VkPipelineViewportStateCreateInfo create(long address)
Returns a newVkPipelineViewportStateCreateInfo
instance for the specified memory address.
-
createSafe
@Nullable public static VkPipelineViewportStateCreateInfo createSafe(long address)
-
malloc
public static VkPipelineViewportStateCreateInfo.Buffer malloc(int capacity)
Returns a newVkPipelineViewportStateCreateInfo.Buffer
instance allocated withmemAlloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
calloc
public static VkPipelineViewportStateCreateInfo.Buffer calloc(int capacity)
Returns a newVkPipelineViewportStateCreateInfo.Buffer
instance allocated withmemCalloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
create
public static VkPipelineViewportStateCreateInfo.Buffer create(int capacity)
Returns a newVkPipelineViewportStateCreateInfo.Buffer
instance allocated withBufferUtils
.- Parameters:
capacity
- the buffer capacity
-
create
public static VkPipelineViewportStateCreateInfo.Buffer create(long address, int capacity)
Create aVkPipelineViewportStateCreateInfo.Buffer
instance at the specified memory.- Parameters:
address
- the memory addresscapacity
- the buffer capacity
-
createSafe
@Nullable public static VkPipelineViewportStateCreateInfo.Buffer createSafe(long address, int capacity)
-
mallocStack
public static VkPipelineViewportStateCreateInfo mallocStack()
Returns a newVkPipelineViewportStateCreateInfo
instance allocated on the thread-localMemoryStack
.
-
callocStack
public static VkPipelineViewportStateCreateInfo callocStack()
Returns a newVkPipelineViewportStateCreateInfo
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.
-
mallocStack
public static VkPipelineViewportStateCreateInfo mallocStack(org.lwjgl.system.MemoryStack stack)
Returns a newVkPipelineViewportStateCreateInfo
instance allocated on the specifiedMemoryStack
.- Parameters:
stack
- the stack from which to allocate
-
callocStack
public static VkPipelineViewportStateCreateInfo callocStack(org.lwjgl.system.MemoryStack stack)
Returns a newVkPipelineViewportStateCreateInfo
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.- Parameters:
stack
- the stack from which to allocate
-
mallocStack
public static VkPipelineViewportStateCreateInfo.Buffer mallocStack(int capacity)
Returns a newVkPipelineViewportStateCreateInfo.Buffer
instance allocated on the thread-localMemoryStack
.- Parameters:
capacity
- the buffer capacity
-
callocStack
public static VkPipelineViewportStateCreateInfo.Buffer callocStack(int capacity)
Returns a newVkPipelineViewportStateCreateInfo.Buffer
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.- Parameters:
capacity
- the buffer capacity
-
mallocStack
public static VkPipelineViewportStateCreateInfo.Buffer mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newVkPipelineViewportStateCreateInfo.Buffer
instance allocated on the specifiedMemoryStack
.- Parameters:
stack
- the stack from which to allocatecapacity
- the buffer capacity
-
callocStack
public static VkPipelineViewportStateCreateInfo.Buffer callocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newVkPipelineViewportStateCreateInfo.Buffer
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.- Parameters:
stack
- the stack from which to allocatecapacity
- the buffer capacity
-
nsType
public static int nsType(long struct)
Unsafe version ofsType()
.
-
npNext
public static long npNext(long struct)
Unsafe version ofpNext()
.
-
nflags
public static int nflags(long struct)
Unsafe version offlags()
.
-
nviewportCount
public static int nviewportCount(long struct)
Unsafe version ofviewportCount()
.
-
npViewports
@Nullable public static VkViewport.Buffer npViewports(long struct)
Unsafe version ofpViewports()
.
-
nscissorCount
public static int nscissorCount(long struct)
Unsafe version ofscissorCount()
.
-
npScissors
@Nullable public static VkRect2D.Buffer npScissors(long struct)
Unsafe version ofpScissors()
.
-
nsType
public static void nsType(long struct, int value)
Unsafe version ofsType
.
-
npNext
public static void npNext(long struct, long value)
Unsafe version ofpNext
.
-
nflags
public static void nflags(long struct, int value)
Unsafe version offlags
.
-
nviewportCount
public static void nviewportCount(long struct, int value)
Sets the specified value to theviewportCount
field of the specifiedstruct
.
-
npViewports
public static void npViewports(long struct, @Nullable VkViewport.Buffer value)
Unsafe version ofpViewports
.
-
nscissorCount
public static void nscissorCount(long struct, int value)
Sets the specified value to thescissorCount
field of the specifiedstruct
.
-
npScissors
public static void npScissors(long struct, @Nullable VkRect2D.Buffer value)
Unsafe version ofpScissors
.
-
-