org.lwjgl.vulkan.VkSurfaceCapabilities2EXT 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 javax.annotation.*;
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 surface.
*
* Valid Usage
*
*
* - {@code supportedSurfaceCounters} must not include {@link EXTDisplaySurfaceCounter#VK_SURFACE_COUNTER_VBLANK_EXT SURFACE_COUNTER_VBLANK_EXT} unless the surface queried is a display surface.
*
*
* Valid Usage (Implicit)
*
*
* - {@code sType} must be {@link EXTDisplaySurfaceCounter#VK_STRUCTURE_TYPE_SURFACE_CAPABILITIES_2_EXT STRUCTURE_TYPE_SURFACE_CAPABILITIES_2_EXT}
* - {@code pNext} must be {@code NULL}
*
*
* See Also
*
* {@link VkExtent2D}, {@link EXTDisplaySurfaceCounter#vkGetPhysicalDeviceSurfaceCapabilities2EXT GetPhysicalDeviceSurfaceCapabilities2EXT}
*
* Member documentation
*
*
* - {@code sType} – the type of this structure.
* - {@code pNext} – {@code NULL} or a pointer to an extension-specific structure.
* - {@code supportedSurfaceCounters} – a bitmask of {@code VkSurfaceCounterFlagBitsEXT} indicating the supported surface counter types.
*
*
* Layout
*
*
* struct VkSurfaceCapabilities2EXT {
* VkStructureType sType;
* void * pNext;
* uint32_t minImageCount;
* uint32_t maxImageCount;
* {@link VkExtent2D VkExtent2D} currentExtent;
* {@link VkExtent2D VkExtent2D} minImageExtent;
* {@link VkExtent2D VkExtent2D} maxImageExtent;
* uint32_t maxImageArrayLayers;
* VkSurfaceTransformFlagsKHR supportedTransforms;
* VkSurfaceTransformFlagBitsKHR currentTransform;
* VkCompositeAlphaFlagsKHR supportedCompositeAlpha;
* VkImageUsageFlags supportedUsageFlags;
* VkSurfaceCounterFlagsEXT supportedSurfaceCounters;
* }The created instance holds a strong reference to the container object.
*/
public VkSurfaceCapabilities2EXT(ByteBuffer container) {
this(memAddress(container), __checkContainer(container, SIZEOF));
}
@Override
public int sizeof() { return SIZEOF; }
/** Returns the value of the {@code sType} field. */
@NativeType("VkStructureType")
public int sType() { return nsType(address()); }
/** Returns the value of the {@code pNext} field. */
@NativeType("void *")
public long pNext() { return npNext(address()); }
/** Returns the value of the {@code minImageCount} field. */
@NativeType("uint32_t")
public int minImageCount() { return nminImageCount(address()); }
/** Returns the value of the {@code maxImageCount} field. */
@NativeType("uint32_t")
public int maxImageCount() { return nmaxImageCount(address()); }
/** Returns a {@link VkExtent2D} view of the {@code currentExtent} field. */
public VkExtent2D currentExtent() { return ncurrentExtent(address()); }
/** Returns a {@link VkExtent2D} view of the {@code minImageExtent} field. */
public VkExtent2D minImageExtent() { return nminImageExtent(address()); }
/** Returns a {@link VkExtent2D} view of the {@code maxImageExtent} field. */
public VkExtent2D maxImageExtent() { return nmaxImageExtent(address()); }
/** Returns the value of the {@code maxImageArrayLayers} field. */
@NativeType("uint32_t")
public int maxImageArrayLayers() { return nmaxImageArrayLayers(address()); }
/** Returns the value of the {@code supportedTransforms} field. */
@NativeType("VkSurfaceTransformFlagsKHR")
public int supportedTransforms() { return nsupportedTransforms(address()); }
/** Returns the value of the {@code currentTransform} field. */
@NativeType("VkSurfaceTransformFlagBitsKHR")
public int currentTransform() { return ncurrentTransform(address()); }
/** Returns the value of the {@code supportedCompositeAlpha} field. */
@NativeType("VkCompositeAlphaFlagsKHR")
public int supportedCompositeAlpha() { return nsupportedCompositeAlpha(address()); }
/** Returns the value of the {@code supportedUsageFlags} field. */
@NativeType("VkImageUsageFlags")
public int supportedUsageFlags() { return nsupportedUsageFlags(address()); }
/** Returns the value of the {@code supportedSurfaceCounters} field. */
@NativeType("VkSurfaceCounterFlagsEXT")
public int supportedSurfaceCounters() { return nsupportedSurfaceCounters(address()); }
// -----------------------------------
/** Returns a new {@link VkSurfaceCapabilities2EXT} instance allocated with {@link MemoryUtil#memAlloc memAlloc}. The instance must be explicitly freed. */
public static VkSurfaceCapabilities2EXT malloc() {
return create(nmemAllocChecked(SIZEOF));
}
/** Returns a new {@link VkSurfaceCapabilities2EXT} instance allocated with {@link MemoryUtil#memCalloc memCalloc}. The instance must be explicitly freed. */
public static VkSurfaceCapabilities2EXT calloc() {
return create(nmemCallocChecked(1, SIZEOF));
}
/** Returns a new {@link VkSurfaceCapabilities2EXT} instance allocated with {@link BufferUtils}. */
public static VkSurfaceCapabilities2EXT create() {
return new VkSurfaceCapabilities2EXT(BufferUtils.createByteBuffer(SIZEOF));
}
/** Returns a new {@link VkSurfaceCapabilities2EXT} instance for the specified memory address. */
public static VkSurfaceCapabilities2EXT create(long address) {
return new VkSurfaceCapabilities2EXT(address, null);
}
/** Like {@link #create(long) create}, but returns {@code null} if {@code address} is {@code NULL}. */
@Nullable
public static VkSurfaceCapabilities2EXT createSafe(long address) {
return address == NULL ? null : create(address);
}
/**
* Returns a new {@link VkSurfaceCapabilities2EXT.Buffer} instance allocated with {@link MemoryUtil#memAlloc memAlloc}. The instance must be explicitly freed.
*
* @param capacity the buffer capacity
*/
public static VkSurfaceCapabilities2EXT.Buffer malloc(int capacity) {
return create(__malloc(capacity, SIZEOF), capacity);
}
/**
* Returns a new {@link VkSurfaceCapabilities2EXT.Buffer} instance allocated with {@link MemoryUtil#memCalloc memCalloc}. The instance must be explicitly freed.
*
* @param capacity the buffer capacity
*/
public static VkSurfaceCapabilities2EXT.Buffer calloc(int capacity) {
return create(nmemCallocChecked(capacity, SIZEOF), capacity);
}
/**
* Returns a new {@link VkSurfaceCapabilities2EXT.Buffer} instance allocated with {@link BufferUtils}.
*
* @param capacity the buffer capacity
*/
public static VkSurfaceCapabilities2EXT.Buffer create(int capacity) {
return new Buffer(__create(capacity, SIZEOF));
}
/**
* Create a {@link VkSurfaceCapabilities2EXT.Buffer} instance at the specified memory.
*
* @param address the memory address
* @param capacity the buffer capacity
*/
public static VkSurfaceCapabilities2EXT.Buffer create(long address, int capacity) {
return new Buffer(address, capacity);
}
/** Like {@link #create(long, int) create}, but returns {@code null} if {@code address} is {@code NULL}. */
@Nullable
public static VkSurfaceCapabilities2EXT.Buffer createSafe(long address, int capacity) {
return address == NULL ? null : create(address, capacity);
}
// -----------------------------------
/** Returns a new {@link VkSurfaceCapabilities2EXT} instance allocated on the thread-local {@link MemoryStack}. */
public static VkSurfaceCapabilities2EXT mallocStack() {
return mallocStack(stackGet());
}
/** Returns a new {@link VkSurfaceCapabilities2EXT} instance allocated on the thread-local {@link MemoryStack} and initializes all its bits to zero. */
public static VkSurfaceCapabilities2EXT callocStack() {
return callocStack(stackGet());
}
/**
* Returns a new {@link VkSurfaceCapabilities2EXT} instance allocated on the specified {@link MemoryStack}.
*
* @param stack the stack from which to allocate
*/
public static VkSurfaceCapabilities2EXT mallocStack(MemoryStack stack) {
return create(stack.nmalloc(ALIGNOF, SIZEOF));
}
/**
* Returns a new {@link VkSurfaceCapabilities2EXT} instance allocated on the specified {@link MemoryStack} and initializes all its bits to zero.
*
* @param stack the stack from which to allocate
*/
public static VkSurfaceCapabilities2EXT callocStack(MemoryStack stack) {
return create(stack.ncalloc(ALIGNOF, 1, SIZEOF));
}
/**
* Returns a new {@link VkSurfaceCapabilities2EXT.Buffer} instance allocated on the thread-local {@link MemoryStack}.
*
* @param capacity the buffer capacity
*/
public static VkSurfaceCapabilities2EXT.Buffer mallocStack(int capacity) {
return mallocStack(capacity, stackGet());
}
/**
* Returns a new {@link VkSurfaceCapabilities2EXT.Buffer} instance allocated on the thread-local {@link MemoryStack} and initializes all its bits to zero.
*
* @param capacity the buffer capacity
*/
public static VkSurfaceCapabilities2EXT.Buffer callocStack(int capacity) {
return callocStack(capacity, stackGet());
}
/**
* Returns a new {@link VkSurfaceCapabilities2EXT.Buffer} instance allocated on the specified {@link MemoryStack}.
*
* @param stack the stack from which to allocate
* @param capacity the buffer capacity
*/
public static VkSurfaceCapabilities2EXT.Buffer mallocStack(int capacity, MemoryStack stack) {
return create(stack.nmalloc(ALIGNOF, capacity * SIZEOF), capacity);
}
/**
* Returns a new {@link VkSurfaceCapabilities2EXT.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 VkSurfaceCapabilities2EXT.Buffer callocStack(int capacity, MemoryStack stack) {
return create(stack.ncalloc(ALIGNOF, capacity, SIZEOF), capacity);
}
// -----------------------------------
/** Unsafe version of {@link #sType}. */
public static int nsType(long struct) { return memGetInt(struct + VkSurfaceCapabilities2EXT.STYPE); }
/** Unsafe version of {@link #pNext}. */
public static long npNext(long struct) { return memGetAddress(struct + VkSurfaceCapabilities2EXT.PNEXT); }
/** Unsafe version of {@link #minImageCount}. */
public static int nminImageCount(long struct) { return memGetInt(struct + VkSurfaceCapabilities2EXT.MINIMAGECOUNT); }
/** Unsafe version of {@link #maxImageCount}. */
public static int nmaxImageCount(long struct) { return memGetInt(struct + VkSurfaceCapabilities2EXT.MAXIMAGECOUNT); }
/** Unsafe version of {@link #currentExtent}. */
public static VkExtent2D ncurrentExtent(long struct) { return VkExtent2D.create(struct + VkSurfaceCapabilities2EXT.CURRENTEXTENT); }
/** Unsafe version of {@link #minImageExtent}. */
public static VkExtent2D nminImageExtent(long struct) { return VkExtent2D.create(struct + VkSurfaceCapabilities2EXT.MINIMAGEEXTENT); }
/** Unsafe version of {@link #maxImageExtent}. */
public static VkExtent2D nmaxImageExtent(long struct) { return VkExtent2D.create(struct + VkSurfaceCapabilities2EXT.MAXIMAGEEXTENT); }
/** Unsafe version of {@link #maxImageArrayLayers}. */
public static int nmaxImageArrayLayers(long struct) { return memGetInt(struct + VkSurfaceCapabilities2EXT.MAXIMAGEARRAYLAYERS); }
/** Unsafe version of {@link #supportedTransforms}. */
public static int nsupportedTransforms(long struct) { return memGetInt(struct + VkSurfaceCapabilities2EXT.SUPPORTEDTRANSFORMS); }
/** Unsafe version of {@link #currentTransform}. */
public static int ncurrentTransform(long struct) { return memGetInt(struct + VkSurfaceCapabilities2EXT.CURRENTTRANSFORM); }
/** Unsafe version of {@link #supportedCompositeAlpha}. */
public static int nsupportedCompositeAlpha(long struct) { return memGetInt(struct + VkSurfaceCapabilities2EXT.SUPPORTEDCOMPOSITEALPHA); }
/** Unsafe version of {@link #supportedUsageFlags}. */
public static int nsupportedUsageFlags(long struct) { return memGetInt(struct + VkSurfaceCapabilities2EXT.SUPPORTEDUSAGEFLAGS); }
/** Unsafe version of {@link #supportedSurfaceCounters}. */
public static int nsupportedSurfaceCounters(long struct) { return memGetInt(struct + VkSurfaceCapabilities2EXT.SUPPORTEDSURFACECOUNTERS); }
// -----------------------------------
/** An array of {@link VkSurfaceCapabilities2EXT} structs. */
public static class Buffer extends StructBuffer implements NativeResource {
/**
* Creates a new {@link VkSurfaceCapabilities2EXT.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 VkSurfaceCapabilities2EXT#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);
}
public Buffer(long address, int cap) {
super(address, null, -1, 0, cap, cap);
}
Buffer(long address, @Nullable 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, @Nullable ByteBuffer container, int mark, int pos, int lim, int cap) {
return new Buffer(address, container, mark, pos, lim, cap);
}
@Override
protected VkSurfaceCapabilities2EXT newInstance(long address) {
return new VkSurfaceCapabilities2EXT(address, container);
}
@Override
public int sizeof() {
return SIZEOF;
}
/** Returns the value of the {@code sType} field. */
@NativeType("VkStructureType")
public int sType() { return VkSurfaceCapabilities2EXT.nsType(address()); }
/** Returns the value of the {@code pNext} field. */
@NativeType("void *")
public long pNext() { return VkSurfaceCapabilities2EXT.npNext(address()); }
/** Returns the value of the {@code minImageCount} field. */
@NativeType("uint32_t")
public int minImageCount() { return VkSurfaceCapabilities2EXT.nminImageCount(address()); }
/** Returns the value of the {@code maxImageCount} field. */
@NativeType("uint32_t")
public int maxImageCount() { return VkSurfaceCapabilities2EXT.nmaxImageCount(address()); }
/** Returns a {@link VkExtent2D} view of the {@code currentExtent} field. */
public VkExtent2D currentExtent() { return VkSurfaceCapabilities2EXT.ncurrentExtent(address()); }
/** Returns a {@link VkExtent2D} view of the {@code minImageExtent} field. */
public VkExtent2D minImageExtent() { return VkSurfaceCapabilities2EXT.nminImageExtent(address()); }
/** Returns a {@link VkExtent2D} view of the {@code maxImageExtent} field. */
public VkExtent2D maxImageExtent() { return VkSurfaceCapabilities2EXT.nmaxImageExtent(address()); }
/** Returns the value of the {@code maxImageArrayLayers} field. */
@NativeType("uint32_t")
public int maxImageArrayLayers() { return VkSurfaceCapabilities2EXT.nmaxImageArrayLayers(address()); }
/** Returns the value of the {@code supportedTransforms} field. */
@NativeType("VkSurfaceTransformFlagsKHR")
public int supportedTransforms() { return VkSurfaceCapabilities2EXT.nsupportedTransforms(address()); }
/** Returns the value of the {@code currentTransform} field. */
@NativeType("VkSurfaceTransformFlagBitsKHR")
public int currentTransform() { return VkSurfaceCapabilities2EXT.ncurrentTransform(address()); }
/** Returns the value of the {@code supportedCompositeAlpha} field. */
@NativeType("VkCompositeAlphaFlagsKHR")
public int supportedCompositeAlpha() { return VkSurfaceCapabilities2EXT.nsupportedCompositeAlpha(address()); }
/** Returns the value of the {@code supportedUsageFlags} field. */
@NativeType("VkImageUsageFlags")
public int supportedUsageFlags() { return VkSurfaceCapabilities2EXT.nsupportedUsageFlags(address()); }
/** Returns the value of the {@code supportedSurfaceCounters} field. */
@NativeType("VkSurfaceCounterFlagsEXT")
public int supportedSurfaceCounters() { return VkSurfaceCapabilities2EXT.nsupportedSurfaceCounters(address()); }
}
}