org.lwjgl.vulkan.KHRWin32Surface 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.system.*;
import static org.lwjgl.system.Checks.*;
import static org.lwjgl.system.JNI.*;
import static org.lwjgl.system.MemoryUtil.*;
/**
* The {@code VK_KHR_win32_surface} extension is an instance extension. It provides a mechanism to create a {@code VkSurfaceKHR} object (defined by the {@link KHRSurface VK_KHR_surface} extension) that refers to a Win32 {@code HWND}, as well as a query to determine support for rendering to the windows desktop.
*
*
* - Name String
* - {@code VK_KHR_win32_surface}
* - Extension Type
* - Instance extension
* - Registered Extension Number
* - 10
* - Revision
* - 6
* - Extension and Version Dependencies
*
* - Requires Vulkan 1.0
* - Requires {@link KHRSurface VK_KHR_surface}
*
- Contact
*
* - Jesse Hall @jessehall,Ian Elliott mailto:[email protected][[email protected]]
*
- Last Modified Date
* - 2017-04-24
* - IP Status
* - No known IP claims.
* - Contributors
*
* - Patrick Doane, Blizzard
* - Jason Ekstrand, Intel
* - Ian Elliott, LunarG
* - Courtney Goeltzenleuchter, LunarG
* - Jesse Hall, Google
* - James Jones, NVIDIA
* - Antoine Labour, Google
* - Jon Leech, Khronos
* - David Mao, AMD
* - Norbert Nopper, Freescale
* - Alon Or-bach, Samsung
* - Daniel Rakos, AMD
* - Graham Sellers, AMD
* - Ray Smith, ARM
* - Jeff Vigil, Qualcomm
* - Chia-I Wu, LunarG
*
*/
public class KHRWin32Surface {
/** The extension specification version. */
public static final int VK_KHR_WIN32_SURFACE_SPEC_VERSION = 6;
/** The extension name. */
public static final String VK_KHR_WIN32_SURFACE_EXTENSION_NAME = "VK_KHR_win32_surface";
/** Extends {@code VkStructureType}. */
public static final int VK_STRUCTURE_TYPE_WIN32_SURFACE_CREATE_INFO_KHR = 1000009000;
protected KHRWin32Surface() {
throw new UnsupportedOperationException();
}
static boolean isAvailable(VKCapabilitiesInstance caps) {
return checkFunctions(
caps.vkCreateWin32SurfaceKHR, caps.vkGetPhysicalDeviceWin32PresentationSupportKHR
);
}
// --- [ vkCreateWin32SurfaceKHR ] ---
/** Unsafe version of: {@link #vkCreateWin32SurfaceKHR CreateWin32SurfaceKHR} */
public static int nvkCreateWin32SurfaceKHR(VkInstance instance, long pCreateInfo, long pAllocator, long pSurface) {
long __functionAddress = instance.getCapabilities().vkCreateWin32SurfaceKHR;
if (CHECKS) {
check(__functionAddress);
VkWin32SurfaceCreateInfoKHR.validate(pCreateInfo);
if (pAllocator != NULL) { VkAllocationCallbacks.validate(pAllocator); }
}
return callPPPPI(__functionAddress, instance.address(), pCreateInfo, pAllocator, pSurface);
}
/**
* Create a {@code VkSurfaceKHR} object for an Win32 native window.
*
* C Specification
*
* To create a {@code VkSurfaceKHR} object for a Win32 window, call:
*
*
* VkResult vkCreateWin32SurfaceKHR(
* VkInstance instance,
* const VkWin32SurfaceCreateInfoKHR* pCreateInfo,
* const VkAllocationCallbacks* pAllocator,
* VkSurfaceKHR* pSurface);Valid Usage (Implicit)
*
*
* - {@code instance} must be a valid {@code VkInstance} handle
* - {@code pCreateInfo} must be a valid pointer to a valid {@link VkWin32SurfaceCreateInfoKHR} structure
* - If {@code pAllocator} is not {@code NULL}, {@code pAllocator} must be a valid pointer to a valid {@link VkAllocationCallbacks} structure
* - {@code pSurface} must be a valid pointer to a {@code VkSurfaceKHR} handle
*
*
* Return Codes
*
*
* - On success, this command returns
*
* - {@link VK10#VK_SUCCESS SUCCESS}
*
- On failure, this command returns
*
* - {@link VK10#VK_ERROR_OUT_OF_HOST_MEMORY ERROR_OUT_OF_HOST_MEMORY}
* - {@link VK10#VK_ERROR_OUT_OF_DEVICE_MEMORY ERROR_OUT_OF_DEVICE_MEMORY}
*
*
* See Also
*
* {@link VkAllocationCallbacks}, {@link VkWin32SurfaceCreateInfoKHR}
*
* @param instance the instance to associate the surface with.
* @param pCreateInfo a pointer to an instance of the {@link VkWin32SurfaceCreateInfoKHR} structure containing parameters affecting the creation of the surface object.
* @param pAllocator the allocator used for host memory allocated for the surface object when there is no more specific allocator available (see Memory Allocation).
* @param pSurface points to a {@code VkSurfaceKHR} handle in which the created surface object is returned.
*/
@NativeType("VkResult")
public static int vkCreateWin32SurfaceKHR(VkInstance instance, @NativeType("const VkWin32SurfaceCreateInfoKHR *") VkWin32SurfaceCreateInfoKHR pCreateInfo, @Nullable @NativeType("const VkAllocationCallbacks *") VkAllocationCallbacks pAllocator, @NativeType("VkSurfaceKHR *") LongBuffer pSurface) {
if (CHECKS) {
check(pSurface, 1);
}
return nvkCreateWin32SurfaceKHR(instance, pCreateInfo.address(), memAddressSafe(pAllocator), memAddress(pSurface));
}
// --- [ vkGetPhysicalDeviceWin32PresentationSupportKHR ] ---
/**
* query queue family support for presentation on a Win32 display.
*
* C Specification
*
* To determine whether a queue family of a physical device supports presentation to the Microsoft Windows desktop, call:
*
*
* VkBool32 vkGetPhysicalDeviceWin32PresentationSupportKHR(
* VkPhysicalDevice physicalDevice,
* uint32_t queueFamilyIndex);Description
*
* This platform-specific function can be called prior to creating a surface.
*
* Valid Usage
*
*
* - {@code queueFamilyIndex} must be less than {@code pQueueFamilyPropertyCount} returned by {@link VK10#vkGetPhysicalDeviceQueueFamilyProperties GetPhysicalDeviceQueueFamilyProperties} for the given {@code physicalDevice}
*
*
* Valid Usage (Implicit)
*
*
* - {@code physicalDevice} must be a valid {@code VkPhysicalDevice} handle
*
*
* @param physicalDevice the physical device.
* @param queueFamilyIndex the queue family index.
*/
@NativeType("VkBool32")
public static boolean vkGetPhysicalDeviceWin32PresentationSupportKHR(VkPhysicalDevice physicalDevice, @NativeType("uint32_t") int queueFamilyIndex) {
long __functionAddress = physicalDevice.getCapabilities().vkGetPhysicalDeviceWin32PresentationSupportKHR;
if (CHECKS) {
check(__functionAddress);
}
return callPI(__functionAddress, physicalDevice.address(), queueFamilyIndex) != 0;
}
/** Array version of: {@link #vkCreateWin32SurfaceKHR CreateWin32SurfaceKHR} */
@NativeType("VkResult")
public static int vkCreateWin32SurfaceKHR(VkInstance instance, @NativeType("const VkWin32SurfaceCreateInfoKHR *") VkWin32SurfaceCreateInfoKHR pCreateInfo, @Nullable @NativeType("const VkAllocationCallbacks *") VkAllocationCallbacks pAllocator, @NativeType("VkSurfaceKHR *") long[] pSurface) {
long __functionAddress = instance.getCapabilities().vkCreateWin32SurfaceKHR;
if (CHECKS) {
check(__functionAddress);
check(pSurface, 1);
VkWin32SurfaceCreateInfoKHR.validate(pCreateInfo.address());
if (pAllocator != null) { VkAllocationCallbacks.validate(pAllocator.address()); }
}
return callPPPPI(__functionAddress, instance.address(), pCreateInfo.address(), memAddressSafe(pAllocator), pSurface);
}
}