VkPipelineViewportStateCreateInfo (LWJGL 3.2.4 SNAPSHOT

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 and VkPhysicalDeviceLimits::maxViewports, inclusive
- scissorCount must be between 1 and VkPhysicalDeviceLimits::maxViewports, inclusive
- scissorCount and viewportCount must be identical
- The x and y members of offset member of any element of pScissors must be greater than or equal to 0
- Evaluation of (offset.x + extent.width) must not cause a signed integer addition overflow for any element of pScissors
- Evaluation of (offset.y + extent.height) must not cause a signed integer addition overflow for any element of pScissors
- If the viewportWScalingEnable member of a VkPipelineViewportWScalingStateCreateInfoNV structure included in the pNext chain is TRUE, the viewportCount member of the VkPipelineViewportWScalingStateCreateInfoNV structure must be equal to viewportCount
Valid Usage (Implicit)
- sType must be STRUCTURE_TYPE_PIPELINE_VIEWPORT_STATE_CREATE_INFO
- Each pNext member of any structure (including this one) in the pNext chain must be either NULL or a pointer to a valid instance of VkPipelineViewportCoarseSampleOrderStateCreateInfoNV, VkPipelineViewportExclusiveScissorStateCreateInfoNV, VkPipelineViewportShadingRateImageStateCreateInfoNV, VkPipelineViewportSwizzleStateCreateInfoNV, or VkPipelineViewportWScalingStateCreateInfoNV
- Each sType member in the pNext chain must be unique
- flags must be 0
- viewportCount must be greater than 0
- scissorCount 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 of VkViewport 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 of VkRect2D structures defining 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 and Description

static class VkPipelineViewportStateCreateInfo.Buffer
An array of VkPipelineViewportStateCreateInfo structs.
- Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer
  org.lwjgl.system.Pointer.Default

Nested Classes
Modifier and Type	Class and Description
`static class`	`VkPipelineViewportStateCreateInfo.Buffer` An array of `VkPipelineViewportStateCreateInfo` structs.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`ALIGNOF` The struct alignment in bytes.
`static int`	`FLAGS` The struct member offsets.
`static int`	`PNEXT` The struct member offsets.
`static int`	`PSCISSORS` The struct member offsets.
`static int`	`PVIEWPORTS` The struct member offsets.
`static int`	`SCISSORCOUNT` The struct member offsets.
`static int`	`SIZEOF` The struct size in bytes.
`static int`	`STYPE` The struct member offsets.
`static int`	`VIEWPORTCOUNT` 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 and Description
`VkPipelineViewportStateCreateInfo(java.nio.ByteBuffer container)` Creates a `VkPipelineViewportStateCreateInfo` instance at the current position of the specified `ByteBuffer` container.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static VkPipelineViewportStateCreateInfo`	`calloc()` Returns a new `VkPipelineViewportStateCreateInfo` instance allocated with `memCalloc`.
`static VkPipelineViewportStateCreateInfo.Buffer`	`calloc(int capacity)` Returns a new `VkPipelineViewportStateCreateInfo.Buffer` instance allocated with `memCalloc`.
`static VkPipelineViewportStateCreateInfo`	`callocStack()` Returns a new `VkPipelineViewportStateCreateInfo` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static VkPipelineViewportStateCreateInfo.Buffer`	`callocStack(int capacity)` Returns a new `VkPipelineViewportStateCreateInfo.Buffer` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static VkPipelineViewportStateCreateInfo.Buffer`	`callocStack(int capacity, org.lwjgl.system.MemoryStack stack)` Returns a new `VkPipelineViewportStateCreateInfo.Buffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static VkPipelineViewportStateCreateInfo`	`callocStack(org.lwjgl.system.MemoryStack stack)` Returns a new `VkPipelineViewportStateCreateInfo` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static VkPipelineViewportStateCreateInfo`	`create()` Returns a new `VkPipelineViewportStateCreateInfo` instance allocated with `BufferUtils`.
`static VkPipelineViewportStateCreateInfo.Buffer`	`create(int capacity)` Returns a new `VkPipelineViewportStateCreateInfo.Buffer` instance allocated with `BufferUtils`.
`static VkPipelineViewportStateCreateInfo`	`create(long address)` Returns a new `VkPipelineViewportStateCreateInfo` instance for the specified memory address.
`static VkPipelineViewportStateCreateInfo.Buffer`	`create(long address, int capacity)` Create a `VkPipelineViewportStateCreateInfo.Buffer` instance at the specified memory.
`static VkPipelineViewportStateCreateInfo`	`createSafe(long address)` Like `create`, but returns `null` if `address` is `NULL`.
`static VkPipelineViewportStateCreateInfo.Buffer`	`createSafe(long address, int capacity)` Like `create`, but returns `null` if `address` is `NULL`.
`int`	`flags()` Returns the value of the `flags` field.
`VkPipelineViewportStateCreateInfo`	`flags(int value)` Sets the specified value to the `flags` field.
`static VkPipelineViewportStateCreateInfo`	`malloc()` Returns a new `VkPipelineViewportStateCreateInfo` instance allocated with `memAlloc`.
`static VkPipelineViewportStateCreateInfo.Buffer`	`malloc(int capacity)` Returns a new `VkPipelineViewportStateCreateInfo.Buffer` instance allocated with `memAlloc`.
`static VkPipelineViewportStateCreateInfo`	`mallocStack()` Returns a new `VkPipelineViewportStateCreateInfo` instance allocated on the thread-local `MemoryStack`.
`static VkPipelineViewportStateCreateInfo.Buffer`	`mallocStack(int capacity)` Returns a new `VkPipelineViewportStateCreateInfo.Buffer` instance allocated on the thread-local `MemoryStack`.
`static VkPipelineViewportStateCreateInfo.Buffer`	`mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)` Returns a new `VkPipelineViewportStateCreateInfo.Buffer` instance allocated on the specified `MemoryStack`.
`static VkPipelineViewportStateCreateInfo`	`mallocStack(org.lwjgl.system.MemoryStack stack)` Returns a new `VkPipelineViewportStateCreateInfo` instance allocated on the specified `MemoryStack`.
`static int`	`nflags(long struct)` Unsafe version of `flags()`.
`static void`	`nflags(long struct, int value)` Unsafe version of `flags`.
`static long`	`npNext(long struct)` Unsafe version of `pNext()`.
`static void`	`npNext(long struct, long value)` Unsafe version of `pNext`.
`static VkRect2D.Buffer`	`npScissors(long struct)` Unsafe version of `pScissors()`.
`static void`	`npScissors(long struct, VkRect2D.Buffer value)` Unsafe version of `pScissors`.
`static VkViewport.Buffer`	`npViewports(long struct)` Unsafe version of `pViewports()`.
`static void`	`npViewports(long struct, VkViewport.Buffer value)` Unsafe version of `pViewports`.
`static int`	`nscissorCount(long struct)` Unsafe version of `scissorCount()`.
`static void`	`nscissorCount(long struct, int value)` Sets the specified value to the `scissorCount` field of the specified `struct`.
`static int`	`nsType(long struct)` Unsafe version of `sType()`.
`static void`	`nsType(long struct, int value)` Unsafe version of `sType`.
`static int`	`nviewportCount(long struct)` Unsafe version of `viewportCount()`.
`static void`	`nviewportCount(long struct, int value)` Sets the specified value to the `viewportCount` field of the specified `struct`.
`long`	`pNext()` Returns the value of the `pNext` field.
`VkPipelineViewportStateCreateInfo`	`pNext(long value)` Sets the specified value to the `pNext` field.
`VkRect2D.Buffer`	`pScissors()` Returns a `VkRect2D.Buffer` view of the struct array pointed to by the `pScissors` field.
`VkPipelineViewportStateCreateInfo`	`pScissors(VkRect2D.Buffer value)` Sets the address of the specified `VkRect2D.Buffer` to the `pScissors` field.
`VkViewport.Buffer`	`pViewports()` Returns a `VkViewport.Buffer` view of the struct array pointed to by the `pViewports` field.
`VkPipelineViewportStateCreateInfo`	`pViewports(VkViewport.Buffer value)` Sets the address of the specified `VkViewport.Buffer` to the `pViewports` field.
`int`	`scissorCount()` Returns the value of the `scissorCount` field.
`VkPipelineViewportStateCreateInfo`	`scissorCount(int value)` Sets the specified value to the `scissorCount` 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 the `sType` field.
`VkPipelineViewportStateCreateInfo`	`sType(int value)` Sets the specified value to the `sType` field.
`int`	`viewportCount()` Returns the value of the `viewportCount` field.
`VkPipelineViewportStateCreateInfo`	`viewportCount(int value)` Sets the specified value to the `viewportCount` field.

Methods inherited from class org.lwjgl.system.Struct
clear, free, isNull

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 Detail
- 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.
- FLAGS
```
public static final int FLAGS
```
  The struct member offsets.
- VIEWPORTCOUNT
```
public static final int VIEWPORTCOUNT
```
  The struct member offsets.
- PVIEWPORTS
```
public static final int PVIEWPORTS
```
  The struct member offsets.
- SCISSORCOUNT
```
public static final int SCISSORCOUNT
```
  The struct member offsets.
- PSCISSORS
```
public static final int PSCISSORS
```
  The struct member offsets.

Constructor Detail
- VkPipelineViewportStateCreateInfo
```
public VkPipelineViewportStateCreateInfo(java.nio.ByteBuffer container)
```
  Creates a VkPipelineViewportStateCreateInfo 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()
```
Returns the value of the sType field.

pNext
```
public long pNext()
```
Returns the value of the pNext field.

flags
```
public int flags()
```
Returns the value of the flags field.

viewportCount
```
public int viewportCount()
```
Returns the value of the viewportCount field.

pViewports
```
@Nullable
public VkViewport.Buffer pViewports()
```
Returns a VkViewport.Buffer view of the struct array pointed to by the pViewports field.

scissorCount
```
public int scissorCount()
```
Returns the value of the scissorCount field.

pScissors
```
@Nullable
public VkRect2D.Buffer pScissors()
```
Returns a VkRect2D.Buffer view of the struct array pointed to by the pScissors field.

sType

public VkPipelineViewportStateCreateInfo sType(int value)

Sets the specified value to the sType field.

pNext

public VkPipelineViewportStateCreateInfo pNext(long value)

Sets the specified value to the pNext field.

flags

public VkPipelineViewportStateCreateInfo flags(int value)

Sets the specified value to the flags field.

viewportCount

public VkPipelineViewportStateCreateInfo viewportCount(int value)

Sets the specified value to the viewportCount field.

pViewports

public VkPipelineViewportStateCreateInfo pViewports(@Nullable
                                                    VkViewport.Buffer value)

Sets the address of the specified VkViewport.Buffer to the pViewports field.

scissorCount

public VkPipelineViewportStateCreateInfo scissorCount(int value)

Sets the specified value to the scissorCount field.

pScissors

public VkPipelineViewportStateCreateInfo pScissors(@Nullable
                                                   VkRect2D.Buffer value)

Sets the address of the specified VkRect2D.Buffer to the pScissors 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 new VkPipelineViewportStateCreateInfo instance allocated with memAlloc. The instance must be explicitly freed.

calloc
```
public static VkPipelineViewportStateCreateInfo calloc()
```
Returns a new VkPipelineViewportStateCreateInfo instance allocated with memCalloc. The instance must be explicitly freed.

create
```
public static VkPipelineViewportStateCreateInfo create()
```
Returns a new VkPipelineViewportStateCreateInfo instance allocated with BufferUtils.

create
```
public static VkPipelineViewportStateCreateInfo create(long address)
```
Returns a new VkPipelineViewportStateCreateInfo instance for the specified memory address.

createSafe

@Nullable
public static VkPipelineViewportStateCreateInfo createSafe(long address)

Like create, but returns null if address is NULL.

malloc
```
public static VkPipelineViewportStateCreateInfo.Buffer malloc(int capacity)
```
Returns a new VkPipelineViewportStateCreateInfo.Buffer instance allocated with memAlloc. The instance must be explicitly freed.

Parameters:

capacity - the buffer capacity

calloc
```
public static VkPipelineViewportStateCreateInfo.Buffer calloc(int capacity)
```
Returns a new VkPipelineViewportStateCreateInfo.Buffer instance allocated with memCalloc. The instance must be explicitly freed.

Parameters:

capacity - the buffer capacity

create
```
public static VkPipelineViewportStateCreateInfo.Buffer create(int capacity)
```
Returns a new VkPipelineViewportStateCreateInfo.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a VkPipelineViewportStateCreateInfo.Buffer instance at the specified memory.

Parameters:: address - the memory address; capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

mallocStack
```
public static VkPipelineViewportStateCreateInfo mallocStack()
```
Returns a new VkPipelineViewportStateCreateInfo instance allocated on the thread-local MemoryStack.

callocStack
```
public static VkPipelineViewportStateCreateInfo callocStack()
```
Returns a new VkPipelineViewportStateCreateInfo instance allocated on the thread-local MemoryStack and initializes all its bits to zero.

mallocStack
```
public static VkPipelineViewportStateCreateInfo mallocStack(org.lwjgl.system.MemoryStack stack)
```
Returns a new VkPipelineViewportStateCreateInfo instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

callocStack
```
public static VkPipelineViewportStateCreateInfo callocStack(org.lwjgl.system.MemoryStack stack)
```
Returns a new VkPipelineViewportStateCreateInfo instance allocated on the specified MemoryStack 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 new VkPipelineViewportStateCreateInfo.Buffer instance allocated on the thread-local MemoryStack.

Parameters:

capacity - the buffer capacity

callocStack
```
public static VkPipelineViewportStateCreateInfo.Buffer callocStack(int capacity)
```
Returns a new VkPipelineViewportStateCreateInfo.Buffer instance allocated on the thread-local MemoryStack 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 new VkPipelineViewportStateCreateInfo.Buffer instance allocated on the specified MemoryStack.

Parameters:: stack - the stack from which to allocate; capacity - the buffer capacity

callocStack
```
public static VkPipelineViewportStateCreateInfo.Buffer callocStack(int capacity,
                                                                   org.lwjgl.system.MemoryStack stack)
```
Returns a new VkPipelineViewportStateCreateInfo.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().

nflags

public static int nflags(long struct)

Unsafe version of flags().

nviewportCount

public static int nviewportCount(long struct)

Unsafe version of viewportCount().

npViewports

@Nullable
public static VkViewport.Buffer npViewports(long struct)

Unsafe version of pViewports().

nscissorCount

public static int nscissorCount(long struct)

Unsafe version of scissorCount().

npScissors

@Nullable
public static VkRect2D.Buffer npScissors(long struct)

Unsafe version of pScissors().

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.

nflags

public static void nflags(long struct,
                          int value)

Unsafe version of flags.

nviewportCount

public static void nviewportCount(long struct,
                                  int value)

Sets the specified value to the viewportCount field of the specified struct.

npViewports

public static void npViewports(long struct,
                               @Nullable
                               VkViewport.Buffer value)

Unsafe version of pViewports.

nscissorCount

public static void nscissorCount(long struct,
                                 int value)

Sets the specified value to the scissorCount field of the specified struct.

npScissors

public static void npScissors(long struct,
                              @Nullable
                              VkRect2D.Buffer value)

Unsafe version of pScissors.

Class VkPipelineViewportStateCreateInfo

Valid Usage

Valid Usage (Implicit)

See Also

Member documentation

Layout

Nested Class Summary

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

Field Summary

Fields inherited from interface org.lwjgl.system.Pointer

Constructor Summary

Method Summary

Methods inherited from class org.lwjgl.system.Struct

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

Methods inherited from class java.lang.Object

Methods inherited from interface org.lwjgl.system.NativeResource

Field Detail

SIZEOF

ALIGNOF

STYPE

PNEXT

FLAGS

VIEWPORTCOUNT

PVIEWPORTS

SCISSORCOUNT

PSCISSORS

Constructor Detail

VkPipelineViewportStateCreateInfo

Method Detail

sizeof

sType

pNext

flags

viewportCount

pViewports

scissorCount

pScissors

sType

pNext

flags

viewportCount

pViewports

scissorCount

pScissors

set

set

malloc

calloc

create

create

createSafe

malloc

calloc

create

create

createSafe

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

nsType

npNext

nflags

nviewportCount

npViewports

nscissorCount

npScissors

nsType

npNext

nflags

nviewportCount

npViewports

nscissorCount

npScissors