The minimum and maximum position and extent fields describe the implementation limits, if any, as they apply to the specified display mode and plane. Vendors may support displaying a subset of a swapchain’s presentable images on the specified display plane. This is expressed by returning minSrcPosition, maxSrcPosition, minSrcExtent, and maxSrcExtent values that indicate a range of possible positions and sizes which may be used to specify the region within the presentable images that source pixels will be read from when creating a swapchain on the specified display mode and plane.
Vendors may also support mapping the presentable images’ content to a subset or superset of the visible region in the specified display mode. This is expressed by returning minDstPosition, maxDstPosition, minDstExtent and maxDstExtent values that indicate a range of possible positions and sizes which may be used to describe the region within the display mode that the source pixels will be mapped to.
Other vendors may support only a 1-1 mapping between pixels in the presentable images and the display mode. This may be indicated by returning (0,0) for minSrcPosition, maxSrcPosition, minDstPosition, and maxDstPosition, and (display mode width, display mode height) for minSrcExtent, maxSrcExtent, minDstExtent, and maxDstExtent.
The value supportedAlpha must contain at least one valid VkDisplayPlaneAlphaFlagBitsKHR bit.
These values indicate the limits of the implementation’s individual fields. Not all combinations of values within the offset and extent ranges returned in VkDisplayPlaneCapabilitiesKHR are guaranteed to be supported. Presentation requests specifying unsupported combinations may fail.
VkDisplayPlaneCapabilities2KHR, VkExtent2D, VkOffset2D, GetDisplayPlaneCapabilitiesKHR
struct VkDisplayPlaneCapabilitiesKHR {
VkDisplayPlaneAlphaFlagsKHR supportedAlpha;
VkOffset2D minSrcPosition;
VkOffset2D maxSrcPosition;
VkExtent2D minSrcExtent;
VkExtent2D maxSrcExtent;
VkOffset2D minDstPosition;
VkOffset2D maxDstPosition;
VkExtent2D minDstExtent;
VkExtent2D maxDstExtent;
}
| Modifier and Type | Class and Description |
|---|---|
| public static class | VkDisplayPlaneCapabilitiesKHR.
An array of |
| Modifier and Type | Field and Description |
|---|---|
| public static final int | ALIGNOF
The struct alignment in bytes. |
| public static final int | MAXDSTEXTENT
The struct member offsets. |
| public static final int | MAXDSTPOSITION
The struct member offsets. |
| public static final int | MAXSRCEXTENT
The struct member offsets. |
| public static final int | MAXSRCPOSITION
The struct member offsets. |
| public static final int | MINDSTEXTENT
The struct member offsets. |
| public static final int | MINDSTPOSITION
The struct member offsets. |
| public static final int | MINSRCEXTENT
The struct member offsets. |
| public static final int | MINSRCPOSITION
The struct member offsets. |
| public static final int | SIZEOF
The struct size in bytes. |
| public static final int | SUPPORTEDALPHA
The struct member offsets. |
| Access | Constructor and Description |
|---|---|
| protected | |
| public | VkDisplayPlaneCapabilitiesKHR(ByteBuffer container)
Creates a |
| Modifier and Type | Method and Description |
|---|---|
| public static VkDisplayPlaneCapabilitiesKHR | |
| public static VkDisplayPlaneCapabilitiesKHR. | calloc(int
the buffer capacity capacity)Returns a new |
| public static VkDisplayPlaneCapabilitiesKHR | calloc(MemoryStack
the stack from which to allocate stack)Returns a new |
| public static VkDisplayPlaneCapabilitiesKHR. | calloc(int
the buffer capacity capacity, MemoryStack the stack from which to allocate stack)Returns a new |
| public static VkDisplayPlaneCapabilitiesKHR | |
| public static VkDisplayPlaneCapabilitiesKHR | |
| public static VkDisplayPlaneCapabilitiesKHR. | |
| public static VkDisplayPlaneCapabilitiesKHR. | |
| protected VkDisplayPlaneCapabilitiesKHR | create(long
the struct memory address address, ByteBuffer an optional container buffer, to be referenced strongly by the struct instance. container)Implements abstract org. the constructor, but returns the exact type of the Struct subclass.
|
| public static VkDisplayPlaneCapabilitiesKHR | |
| public static VkDisplayPlaneCapabilitiesKHR | create(long address)
Returns a new |
| public static VkDisplayPlaneCapabilitiesKHR. | create(int
the buffer capacity capacity)Returns a new |
| public static VkDisplayPlaneCapabilitiesKHR. | create(long
the memory address address, int the buffer capacity capacity)Create a |
| public static VkDisplayPlaneCapabilitiesKHR | |
| public static VkDisplayPlaneCapabilitiesKHR. | |
| public static VkDisplayPlaneCapabilitiesKHR | |
| public static VkDisplayPlaneCapabilitiesKHR. | malloc(int
the buffer capacity capacity)Returns a new |
| public static VkDisplayPlaneCapabilitiesKHR | malloc(MemoryStack
the stack from which to allocate stack)Returns a new |
| public static VkDisplayPlaneCapabilitiesKHR. | malloc(int
the buffer capacity capacity, MemoryStack the stack from which to allocate stack)Returns a new |
| public static VkDisplayPlaneCapabilitiesKHR | |
| public static VkDisplayPlaneCapabilitiesKHR | |
| public static VkDisplayPlaneCapabilitiesKHR. | |
| public static VkDisplayPlaneCapabilitiesKHR. | |
| public VkExtent2D | |
| public VkOffset2D | |
| public VkExtent2D | |
| public VkOffset2D | maxSrcPosition()
the maximum source rectangle offset supported by this plane using the specified mode. |
| public VkExtent2D | |
| public VkOffset2D | minDstPosition()
|
| public VkExtent2D | |
| public VkOffset2D | minSrcPosition()
the minimum source rectangle offset supported by this plane using the specified mode. |
| public static VkExtent2D | |
| public static VkOffset2D | |
| public static VkExtent2D | |
| public static VkOffset2D | |
| public static VkExtent2D | |
| public static VkOffset2D | |
| public static VkExtent2D | |
| public static VkOffset2D | |
| public static int | |
| public int | |
| public int | supportedAlpha()
a bitmask of |
| ALIGNOF | back to summary |
|---|---|
| public static final int ALIGNOF The struct alignment in bytes. | |
| MAXDSTEXTENT | back to summary |
|---|---|
| public static final int MAXDSTEXTENT The struct member offsets. | |
| MAXDSTPOSITION | back to summary |
|---|---|
| public static final int MAXDSTPOSITION The struct member offsets. | |
| MAXSRCEXTENT | back to summary |
|---|---|
| public static final int MAXSRCEXTENT The struct member offsets. | |
| MAXSRCPOSITION | back to summary |
|---|---|
| public static final int MAXSRCPOSITION The struct member offsets. | |
| MINDSTEXTENT | back to summary |
|---|---|
| public static final int MINDSTEXTENT The struct member offsets. | |
| MINDSTPOSITION | back to summary |
|---|---|
| public static final int MINDSTPOSITION The struct member offsets. | |
| MINSRCEXTENT | back to summary |
|---|---|
| public static final int MINSRCEXTENT The struct member offsets. | |
| MINSRCPOSITION | back to summary |
|---|---|
| public static final int MINSRCPOSITION The struct member offsets. | |
| SIZEOF | back to summary |
|---|---|
| public static final int SIZEOF The struct size in bytes. | |
| SUPPORTEDALPHA | back to summary |
|---|---|
| public static final int SUPPORTEDALPHA The struct member offsets. | |
| VkDisplayPlaneCapabilitiesKHR | back to summary |
|---|---|
| protected VkDisplayPlaneCapabilitiesKHR(long address, ByteBuffer container) | |
| VkDisplayPlaneCapabilitiesKHR | back to summary |
|---|---|
| public VkDisplayPlaneCapabilitiesKHR(ByteBuffer container) Creates a The created instance holds a strong reference to the container object. | |
| calloc | back to summary |
|---|---|
| public static VkDisplayPlaneCapabilitiesKHR calloc() Returns a new | |
| calloc | back to summary |
|---|---|
| public static VkDisplayPlaneCapabilitiesKHR. Returns a new
| |
| calloc | back to summary |
|---|---|
| public static VkDisplayPlaneCapabilitiesKHR calloc(MemoryStack stack) Returns a new
| |
| calloc | back to summary |
|---|---|
| public static VkDisplayPlaneCapabilitiesKHR. Returns a new
| |
| callocStack | back to summary |
|---|---|
| public static VkDisplayPlaneCapabilitiesKHR callocStack()
Deprecated
Deprecated for removal in 3.4.0. Use
| |
| callocStack | back to summary |
|---|---|
| public static VkDisplayPlaneCapabilitiesKHR callocStack(MemoryStack stack)
Deprecated
Deprecated for removal in 3.4.0. Use
| |
| callocStack | back to summary |
|---|---|
| public static VkDisplayPlaneCapabilitiesKHR. Deprecated
Deprecated for removal in 3.4.0. Use
| |
| callocStack | back to summary |
|---|---|
| public static VkDisplayPlaneCapabilitiesKHR. Deprecated
Deprecated for removal in 3.4.0. Use
| |
| create | back to summary |
|---|---|
| protected VkDisplayPlaneCapabilitiesKHR create(long address, ByteBuffer container) Implements abstract org. Doc from org. Similar to Effectively, every
| |
| create | back to summary |
|---|---|
| public static VkDisplayPlaneCapabilitiesKHR create() Returns a new | |
| create | back to summary |
|---|---|
| public static VkDisplayPlaneCapabilitiesKHR create(long address) Returns a new | |
| create | back to summary |
|---|---|
| public static VkDisplayPlaneCapabilitiesKHR. Returns a new
| |
| create | back to summary |
|---|---|
| public static VkDisplayPlaneCapabilitiesKHR. Create a
| |
| createSafe | back to summary |
|---|---|
| public static VkDisplayPlaneCapabilitiesKHR createSafe(long address) Like
| |
| createSafe | back to summary |
|---|---|
| public static VkDisplayPlaneCapabilitiesKHR. Like
| |
| malloc | back to summary |
|---|---|
| public static VkDisplayPlaneCapabilitiesKHR malloc() Returns a new | |
| malloc | back to summary |
|---|---|
| public static VkDisplayPlaneCapabilitiesKHR. Returns a new
| |
| malloc | back to summary |
|---|---|
| public static VkDisplayPlaneCapabilitiesKHR malloc(MemoryStack stack) Returns a new
| |
| malloc | back to summary |
|---|---|
| public static VkDisplayPlaneCapabilitiesKHR. Returns a new
| |
| mallocStack | back to summary |
|---|---|
| public static VkDisplayPlaneCapabilitiesKHR mallocStack()
Deprecated
Deprecated for removal in 3.4.0. Use
| |
| mallocStack | back to summary |
|---|---|
| public static VkDisplayPlaneCapabilitiesKHR mallocStack(MemoryStack stack)
Deprecated
Deprecated for removal in 3.4.0. Use
| |
| mallocStack | back to summary |
|---|---|
| public static VkDisplayPlaneCapabilitiesKHR. Deprecated
Deprecated for removal in 3.4.0. Use
| |
| mallocStack | back to summary |
|---|---|
| public static VkDisplayPlaneCapabilitiesKHR. Deprecated
Deprecated for removal in 3.4.0. Use
| |
| maxDstExtent | back to summary |
|---|---|
| public VkExtent2D maxDstExtent() see | |
| maxDstPosition | back to summary |
|---|---|
| public VkOffset2D maxDstPosition() see | |
| maxSrcExtent | back to summary |
|---|---|
| public VkExtent2D maxSrcExtent() the maximum source rectangle size supported by this plane using the specified mode. | |
| maxSrcPosition | back to summary |
|---|---|
| public VkOffset2D maxSrcPosition() the maximum source rectangle offset supported by this plane using the specified mode. The | |
| minDstExtent | back to summary |
|---|---|
| public VkExtent2D minDstExtent() see | |
| minDstPosition | back to summary |
|---|---|
| public VkOffset2D minDstPosition()
| |
| minSrcExtent | back to summary |
|---|---|
| public VkExtent2D minSrcExtent() the minimum source rectangle size supported by this plane using the specified mode. | |
| minSrcPosition | back to summary |
|---|---|
| public VkOffset2D minSrcPosition() the minimum source rectangle offset supported by this plane using the specified mode. | |
| nmaxDstExtent | back to summary |
|---|---|
| public static VkExtent2D nmaxDstExtent(long struct) Unsafe version of | |
| nmaxDstPosition | back to summary |
|---|---|
| public static VkOffset2D nmaxDstPosition(long struct) Unsafe version of | |
| nmaxSrcExtent | back to summary |
|---|---|
| public static VkExtent2D nmaxSrcExtent(long struct) Unsafe version of | |
| nmaxSrcPosition | back to summary |
|---|---|
| public static VkOffset2D nmaxSrcPosition(long struct) Unsafe version of | |
| nminDstExtent | back to summary |
|---|---|
| public static VkExtent2D nminDstExtent(long struct) Unsafe version of | |
| nminDstPosition | back to summary |
|---|---|
| public static VkOffset2D nminDstPosition(long struct) Unsafe version of | |
| nminSrcExtent | back to summary |
|---|---|
| public static VkExtent2D nminSrcExtent(long struct) Unsafe version of | |
| nminSrcPosition | back to summary |
|---|---|
| public static VkOffset2D nminSrcPosition(long struct) Unsafe version of | |
| nsupportedAlpha | back to summary |
|---|---|
| public static int nsupportedAlpha(long struct) Unsafe version of | |
| sizeof | back to summary |
|---|---|
| public int sizeof() Implements abstract org. Doc from org. Returns
| |
| supportedAlpha | back to summary |
|---|---|
| public int supportedAlpha() a bitmask of
| |
VkDisplayPlaneCapabilitiesKHR structs.
| Modifier and Type | Field and Description |
|---|---|
| private static final VkDisplayPlaneCapabilitiesKHR |
| Access | Constructor and Description |
|---|---|
| public | Buffer(ByteBuffer container)
Creates a new |
| public | |
| pack-priv |
| Modifier and Type | Method and Description |
|---|---|
| protected VkDisplayPlaneCapabilitiesKHR | |
| public VkExtent2D | |
| public VkOffset2D | |
| public VkExtent2D | |
| public VkOffset2D | |
| public VkExtent2D | |
| public VkOffset2D | |
| public VkExtent2D | |
| public VkOffset2D | |
| protected VkDisplayPlaneCapabilitiesKHR. | |
| public int |
| ELEMENT_FACTORY | back to summary |
|---|---|
| private static final VkDisplayPlaneCapabilitiesKHR ELEMENT_FACTORY | |
| Buffer | back to summary |
|---|---|
| public Buffer(ByteBuffer container) Creates a new 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 The created buffer instance holds a strong reference to the container object. | |
| Buffer | back to summary |
|---|---|
| public Buffer(long address, int cap) | |
| Buffer | back to summary |
|---|---|
| pack-priv Buffer(long address, ByteBuffer container, int mark, int pos, int lim, int cap) | |
| getElementFactory | back to summary |
|---|---|
| protected VkDisplayPlaneCapabilitiesKHR getElementFactory() Implements abstract org.
| |
| maxDstExtent | back to summary |
|---|---|
public VkExtent2D maxDstExtent()
| |
| maxDstPosition | back to summary |
|---|---|
public VkOffset2D maxDstPosition()
| |
| maxSrcExtent | back to summary |
|---|---|
public VkExtent2D maxSrcExtent()
| |
| maxSrcPosition | back to summary |
|---|---|
public VkOffset2D maxSrcPosition()
| |
| minDstExtent | back to summary |
|---|---|
public VkExtent2D minDstExtent()
| |
| minDstPosition | back to summary |
|---|---|
public VkOffset2D minDstPosition()
| |
| minSrcExtent | back to summary |
|---|---|
public VkExtent2D minSrcExtent()
| |
| minSrcPosition | back to summary |
|---|---|
public VkOffset2D minSrcPosition()
| |
| self | back to summary |
|---|---|
| protected VkDisplayPlaneCapabilitiesKHR. Implements abstract org.
| |
| supportedAlpha | back to summary |
|---|---|
public int supportedAlpha()
| |