org.lwjgl.vulkan.VkDisplayPlaneCapabilitiesKHR Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of lwjgl-vulkan Show documentation
Show all versions of lwjgl-vulkan Show documentation
A new generation graphics and compute API that provides high-efficiency, cross-platform access to modern GPUs used in a wide variety of devices from PCs and consoles to mobile phones and embedded platforms.
/*
* Copyright LWJGL. All rights reserved.
* License terms: https://www.lwjgl.org/license
* MACHINE GENERATED FILE, DO NOT EDIT
*/
package org.lwjgl.vulkan;
import java.nio.*;
import org.lwjgl.*;
import org.lwjgl.system.*;
import static org.lwjgl.system.MemoryUtil.*;
import static org.lwjgl.system.MemoryStack.*;
/**
* Structure describing capabilities of a mode and plane combination.
*
* Description
*
* The minimum and maximum position and extent fields describe the hardware 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 {@code minSrcPosition}, {@code maxSrcPosition}, {@code minSrcExtent}, and {@code maxSrcExtent} values that indicate a range of possible positions and sizes 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 {@code minDstPosition}, {@code maxDstPosition}, {@code minDstExtent} and {@code maxDstExtent} values that indicate a range of possible positions and sizes 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 {@code minSrcPosition}, {@code maxSrcPosition}, {@code minDstPosition}, and {@code maxDstPosition}, and (display mode width, display mode height) for {@code minSrcExtent}, {@code maxSrcExtent}, {@code minDstExtent}, and {@code maxDstExtent}.
*
* These values indicate the limits of the hardware's individual fields. Not all combinations of values within the offset and extent ranges returned in {@link VkDisplayPlaneCapabilitiesKHR} are guaranteed to be supported. Vendors may still fail presentation requests that specify unsupported combinations.
*
* See Also
*
* {@link VkExtent2D}, {@link VkOffset2D}, {@link KHRDisplay#vkGetDisplayPlaneCapabilitiesKHR GetDisplayPlaneCapabilitiesKHR}
*
* Member documentation
*
*
* - {@code supportedAlpha} – a bitmask of {@code VkDisplayPlaneAlphaFlagBitsKHR} describing the supported alpha blending modes.
* - {@code minSrcPosition} – the minimum source rectangle offset supported by this plane using the specified mode.
* - {@code maxSrcPosition} – the maximum source rectangle offset supported by this plane using the specified mode. The {@code x} and {@code y} components of {@code maxSrcPosition} must each be greater than or equal to the {@code x} and {@code y} components of {@code minSrcPosition}, respectively.
* - {@code minSrcExtent} – the minimum source rectangle size supported by this plane using the specified mode.
* - {@code maxSrcExtent} – the maximum source rectangle size supported by this plane using the specified mode.
* - {@code minDstPosition} – {@code minDstPosition}, {@code maxDstPosition}, {@code minDstExtent}, {@code maxDstExtent} all have similar semantics to their corresponding "Src" equivalents, but apply to the output region within the mode rather than the input region within the source image. Unlike the "Src" offsets, {@code minDstPosition} and {@code maxDstPosition} may contain negative values.
* - {@code maxDstPosition} – see {@code minDstPosition}
* - {@code minDstExtent} – see {@code minDstPosition}
* - {@code maxDstExtent} – see {@code minDstPosition}
*
*
* Layout
*
*
* struct VkDisplayPlaneCapabilitiesKHR {
* VkDisplayPlaneAlphaFlagsKHR supportedAlpha;
* {@link VkOffset2D VkOffset2D} minSrcPosition;
* {@link VkOffset2D VkOffset2D} maxSrcPosition;
* {@link VkExtent2D VkExtent2D} minSrcExtent;
* {@link VkExtent2D VkExtent2D} maxSrcExtent;
* {@link VkOffset2D VkOffset2D} minDstPosition;
* {@link VkOffset2D VkOffset2D} maxDstPosition;
* {@link VkExtent2D VkExtent2D} minDstExtent;
* {@link VkExtent2D VkExtent2D} maxDstExtent;
* }The created instance holds a strong reference to the container object.
*/
public VkDisplayPlaneCapabilitiesKHR(ByteBuffer container) {
this(memAddress(container), checkContainer(container, SIZEOF));
}
@Override
public int sizeof() { return SIZEOF; }
/** Returns the value of the {@code supportedAlpha} field. */
@NativeType("VkDisplayPlaneAlphaFlagsKHR")
public int supportedAlpha() { return nsupportedAlpha(address()); }
/** Returns a {@link VkOffset2D} view of the {@code minSrcPosition} field. */
public VkOffset2D minSrcPosition() { return nminSrcPosition(address()); }
/** Returns a {@link VkOffset2D} view of the {@code maxSrcPosition} field. */
public VkOffset2D maxSrcPosition() { return nmaxSrcPosition(address()); }
/** Returns a {@link VkExtent2D} view of the {@code minSrcExtent} field. */
public VkExtent2D minSrcExtent() { return nminSrcExtent(address()); }
/** Returns a {@link VkExtent2D} view of the {@code maxSrcExtent} field. */
public VkExtent2D maxSrcExtent() { return nmaxSrcExtent(address()); }
/** Returns a {@link VkOffset2D} view of the {@code minDstPosition} field. */
public VkOffset2D minDstPosition() { return nminDstPosition(address()); }
/** Returns a {@link VkOffset2D} view of the {@code maxDstPosition} field. */
public VkOffset2D maxDstPosition() { return nmaxDstPosition(address()); }
/** Returns a {@link VkExtent2D} view of the {@code minDstExtent} field. */
public VkExtent2D minDstExtent() { return nminDstExtent(address()); }
/** Returns a {@link VkExtent2D} view of the {@code maxDstExtent} field. */
public VkExtent2D maxDstExtent() { return nmaxDstExtent(address()); }
// -----------------------------------
/** Returns a new {@link VkDisplayPlaneCapabilitiesKHR} instance allocated with {@link MemoryUtil#memAlloc memAlloc}. The instance must be explicitly freed. */
public static VkDisplayPlaneCapabilitiesKHR malloc() {
return create(nmemAlloc(SIZEOF));
}
/** Returns a new {@link VkDisplayPlaneCapabilitiesKHR} instance allocated with {@link MemoryUtil#memCalloc memCalloc}. The instance must be explicitly freed. */
public static VkDisplayPlaneCapabilitiesKHR calloc() {
return create(nmemCalloc(1, SIZEOF));
}
/** Returns a new {@link VkDisplayPlaneCapabilitiesKHR} instance allocated with {@link BufferUtils}. */
public static VkDisplayPlaneCapabilitiesKHR create() {
return new VkDisplayPlaneCapabilitiesKHR(BufferUtils.createByteBuffer(SIZEOF));
}
/** Returns a new {@link VkDisplayPlaneCapabilitiesKHR} instance for the specified memory address or {@code null} if the address is {@code NULL}. */
public static VkDisplayPlaneCapabilitiesKHR create(long address) {
return address == NULL ? null : new VkDisplayPlaneCapabilitiesKHR(address, null);
}
/**
* Returns a new {@link VkDisplayPlaneCapabilitiesKHR.Buffer} instance allocated with {@link MemoryUtil#memAlloc memAlloc}. The instance must be explicitly freed.
*
* @param capacity the buffer capacity
*/
public static Buffer malloc(int capacity) {
return create(__malloc(capacity, SIZEOF), capacity);
}
/**
* Returns a new {@link VkDisplayPlaneCapabilitiesKHR.Buffer} instance allocated with {@link MemoryUtil#memCalloc memCalloc}. The instance must be explicitly freed.
*
* @param capacity the buffer capacity
*/
public static Buffer calloc(int capacity) {
return create(nmemCalloc(capacity, SIZEOF), capacity);
}
/**
* Returns a new {@link VkDisplayPlaneCapabilitiesKHR.Buffer} instance allocated with {@link BufferUtils}.
*
* @param capacity the buffer capacity
*/
public static Buffer create(int capacity) {
return new Buffer(__create(capacity, SIZEOF));
}
/**
* Create a {@link VkDisplayPlaneCapabilitiesKHR.Buffer} instance at the specified memory.
*
* @param address the memory address
* @param capacity the buffer capacity
*/
public static Buffer create(long address, int capacity) {
return address == NULL ? null : new Buffer(address, null, -1, 0, capacity, capacity);
}
// -----------------------------------
/** Returns a new {@link VkDisplayPlaneCapabilitiesKHR} instance allocated on the thread-local {@link MemoryStack}. */
public static VkDisplayPlaneCapabilitiesKHR mallocStack() {
return mallocStack(stackGet());
}
/** Returns a new {@link VkDisplayPlaneCapabilitiesKHR} instance allocated on the thread-local {@link MemoryStack} and initializes all its bits to zero. */
public static VkDisplayPlaneCapabilitiesKHR callocStack() {
return callocStack(stackGet());
}
/**
* Returns a new {@link VkDisplayPlaneCapabilitiesKHR} instance allocated on the specified {@link MemoryStack}.
*
* @param stack the stack from which to allocate
*/
public static VkDisplayPlaneCapabilitiesKHR mallocStack(MemoryStack stack) {
return create(stack.nmalloc(ALIGNOF, SIZEOF));
}
/**
* Returns a new {@link VkDisplayPlaneCapabilitiesKHR} instance allocated on the specified {@link MemoryStack} and initializes all its bits to zero.
*
* @param stack the stack from which to allocate
*/
public static VkDisplayPlaneCapabilitiesKHR callocStack(MemoryStack stack) {
return create(stack.ncalloc(ALIGNOF, 1, SIZEOF));
}
/**
* Returns a new {@link VkDisplayPlaneCapabilitiesKHR.Buffer} instance allocated on the thread-local {@link MemoryStack}.
*
* @param capacity the buffer capacity
*/
public static Buffer mallocStack(int capacity) {
return mallocStack(capacity, stackGet());
}
/**
* Returns a new {@link VkDisplayPlaneCapabilitiesKHR.Buffer} instance allocated on the thread-local {@link MemoryStack} and initializes all its bits to zero.
*
* @param capacity the buffer capacity
*/
public static Buffer callocStack(int capacity) {
return callocStack(capacity, stackGet());
}
/**
* Returns a new {@link VkDisplayPlaneCapabilitiesKHR.Buffer} instance allocated on the specified {@link MemoryStack}.
*
* @param stack the stack from which to allocate
* @param capacity the buffer capacity
*/
public static Buffer mallocStack(int capacity, MemoryStack stack) {
return create(stack.nmalloc(ALIGNOF, capacity * SIZEOF), capacity);
}
/**
* Returns a new {@link VkDisplayPlaneCapabilitiesKHR.Buffer} instance allocated on the specified {@link MemoryStack} and initializes all its bits to zero.
*
* @param stack the stack from which to allocate
* @param capacity the buffer capacity
*/
public static Buffer callocStack(int capacity, MemoryStack stack) {
return create(stack.ncalloc(ALIGNOF, capacity, SIZEOF), capacity);
}
// -----------------------------------
/** Unsafe version of {@link #supportedAlpha}. */
public static int nsupportedAlpha(long struct) { return memGetInt(struct + VkDisplayPlaneCapabilitiesKHR.SUPPORTEDALPHA); }
/** Unsafe version of {@link #minSrcPosition}. */
public static VkOffset2D nminSrcPosition(long struct) { return VkOffset2D.create(struct + VkDisplayPlaneCapabilitiesKHR.MINSRCPOSITION); }
/** Unsafe version of {@link #maxSrcPosition}. */
public static VkOffset2D nmaxSrcPosition(long struct) { return VkOffset2D.create(struct + VkDisplayPlaneCapabilitiesKHR.MAXSRCPOSITION); }
/** Unsafe version of {@link #minSrcExtent}. */
public static VkExtent2D nminSrcExtent(long struct) { return VkExtent2D.create(struct + VkDisplayPlaneCapabilitiesKHR.MINSRCEXTENT); }
/** Unsafe version of {@link #maxSrcExtent}. */
public static VkExtent2D nmaxSrcExtent(long struct) { return VkExtent2D.create(struct + VkDisplayPlaneCapabilitiesKHR.MAXSRCEXTENT); }
/** Unsafe version of {@link #minDstPosition}. */
public static VkOffset2D nminDstPosition(long struct) { return VkOffset2D.create(struct + VkDisplayPlaneCapabilitiesKHR.MINDSTPOSITION); }
/** Unsafe version of {@link #maxDstPosition}. */
public static VkOffset2D nmaxDstPosition(long struct) { return VkOffset2D.create(struct + VkDisplayPlaneCapabilitiesKHR.MAXDSTPOSITION); }
/** Unsafe version of {@link #minDstExtent}. */
public static VkExtent2D nminDstExtent(long struct) { return VkExtent2D.create(struct + VkDisplayPlaneCapabilitiesKHR.MINDSTEXTENT); }
/** Unsafe version of {@link #maxDstExtent}. */
public static VkExtent2D nmaxDstExtent(long struct) { return VkExtent2D.create(struct + VkDisplayPlaneCapabilitiesKHR.MAXDSTEXTENT); }
// -----------------------------------
/** An array of {@link VkDisplayPlaneCapabilitiesKHR} structs. */
public static class Buffer extends StructBuffer implements NativeResource {
/**
* Creates a new {@link VkDisplayPlaneCapabilitiesKHR.Buffer} instance backed by the specified container.
*
* 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 {@link VkDisplayPlaneCapabilitiesKHR#SIZEOF}, and its mark will be undefined.
*
* The created buffer instance holds a strong reference to the container object.
*/
public Buffer(ByteBuffer container) {
super(container, container.remaining() / SIZEOF);
}
Buffer(long address, ByteBuffer container, int mark, int pos, int lim, int cap) {
super(address, container, mark, pos, lim, cap);
}
@Override
protected Buffer self() {
return this;
}
@Override
protected Buffer newBufferInstance(long address, ByteBuffer container, int mark, int pos, int lim, int cap) {
return new Buffer(address, container, mark, pos, lim, cap);
}
@Override
protected VkDisplayPlaneCapabilitiesKHR newInstance(long address) {
return new VkDisplayPlaneCapabilitiesKHR(address, container);
}
@Override
public int sizeof() {
return SIZEOF;
}
/** Returns the value of the {@code supportedAlpha} field. */
@NativeType("VkDisplayPlaneAlphaFlagsKHR")
public int supportedAlpha() { return VkDisplayPlaneCapabilitiesKHR.nsupportedAlpha(address()); }
/** Returns a {@link VkOffset2D} view of the {@code minSrcPosition} field. */
public VkOffset2D minSrcPosition() { return VkDisplayPlaneCapabilitiesKHR.nminSrcPosition(address()); }
/** Returns a {@link VkOffset2D} view of the {@code maxSrcPosition} field. */
public VkOffset2D maxSrcPosition() { return VkDisplayPlaneCapabilitiesKHR.nmaxSrcPosition(address()); }
/** Returns a {@link VkExtent2D} view of the {@code minSrcExtent} field. */
public VkExtent2D minSrcExtent() { return VkDisplayPlaneCapabilitiesKHR.nminSrcExtent(address()); }
/** Returns a {@link VkExtent2D} view of the {@code maxSrcExtent} field. */
public VkExtent2D maxSrcExtent() { return VkDisplayPlaneCapabilitiesKHR.nmaxSrcExtent(address()); }
/** Returns a {@link VkOffset2D} view of the {@code minDstPosition} field. */
public VkOffset2D minDstPosition() { return VkDisplayPlaneCapabilitiesKHR.nminDstPosition(address()); }
/** Returns a {@link VkOffset2D} view of the {@code maxDstPosition} field. */
public VkOffset2D maxDstPosition() { return VkDisplayPlaneCapabilitiesKHR.nmaxDstPosition(address()); }
/** Returns a {@link VkExtent2D} view of the {@code minDstExtent} field. */
public VkExtent2D minDstExtent() { return VkDisplayPlaneCapabilitiesKHR.nminDstExtent(address()); }
/** Returns a {@link VkExtent2D} view of the {@code maxDstExtent} field. */
public VkExtent2D maxDstExtent() { return VkDisplayPlaneCapabilitiesKHR.nmaxDstExtent(address()); }
}
}