Top Description Fields Constructors Methods
org.lwjgl.vulkan

public Class KHRWaylandSurface

extends Object
Class Inheritance
Imports
javax.annotation.*, java.nio.*, org.lwjgl.system.*, org.lwjgl.system.linux.*
The VK_KHR_wayland_surface extension is an instance extension. It provides a mechanism to create a VkSurfaceKHR object (defined by the VK_KHR_surface extension) that refers to a Wayland wl_surface, as well as a query to determine support for rendering to a Wayland compositor.
VK_KHR_wayland_surface
Name String
VK_KHR_wayland_surface
Extension Type
Instance extension
Registered Extension Number
7
Revision
6
Extension and Version Dependencies
VK_KHR_surface
Contact
Other Extension Metadata
Last Modified Date
2015-11-28
IP Status
No known IP claims.
Contributors
  • Patrick Doane, Blizzard
  • Faith 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

Field Summary

Modifier and TypeField and Description
public static final String
VK_KHR_WAYLAND_SURFACE_EXTENSION_NAME

The extension name.

public static final int
VK_KHR_WAYLAND_SURFACE_SPEC_VERSION

The extension specification version.

public static final int
VK_STRUCTURE_TYPE_WAYLAND_SURFACE_CREATE_INFO_KHR

Extends VkStructureType.

Constructor Summary

AccessConstructor and Description
protected
KHRWaylandSurface()

Method Summary

Modifier and TypeMethod and Description
public static int
nvkCreateWaylandSurfaceKHR(VkInstance instance, long pCreateInfo, long pAllocator, long pSurface)

Unsafe version of: CreateWaylandSurfaceKHR

public static int
vkCreateWaylandSurfaceKHR(VkInstance
the instance to associate the surface with.
instance, VkWaylandSurfaceCreateInfoKHR
a pointer to a VkWaylandSurfaceCreateInfoKHR structure containing parameters affecting the creation of the surface object.
pCreateInfo, VkAllocationCallbacks
the allocator used for host memory allocated for the surface object when there is no more specific allocator available (see Memory Allocation).
pAllocator, LongBuffer
a pointer to a VkSurfaceKHR handle in which the created surface object is returned.
pSurface)

Create a VkSurfaceKHR object for a Wayland window.

public static int
vkCreateWaylandSurfaceKHR(VkInstance instance, VkWaylandSurfaceCreateInfoKHR pCreateInfo, VkAllocationCallbacks pAllocator, long[] pSurface)

Array version of: CreateWaylandSurfaceKHR

public static boolean
vkGetPhysicalDeviceWaylandPresentationSupportKHR(VkPhysicalDevice
the physical device.
physicalDevice, int
the queue family index.
queueFamilyIndex, long
a pointer to the wl_display associated with a Wayland compositor.
display)

Query physical device for presentation to Wayland.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

VK_KHR_WAYLAND_SURFACE_EXTENSION_NAMEback to summary
public static final String VK_KHR_WAYLAND_SURFACE_EXTENSION_NAME

The extension name.

VK_KHR_WAYLAND_SURFACE_SPEC_VERSIONback to summary
public static final int VK_KHR_WAYLAND_SURFACE_SPEC_VERSION

The extension specification version.

VK_STRUCTURE_TYPE_WAYLAND_SURFACE_CREATE_INFO_KHRback to summary
public static final int VK_STRUCTURE_TYPE_WAYLAND_SURFACE_CREATE_INFO_KHR

Extends VkStructureType.

Constructor Detail

KHRWaylandSurfaceback to summary
protected KHRWaylandSurface()

Method Detail

nvkCreateWaylandSurfaceKHRback to summary
public static int nvkCreateWaylandSurfaceKHR(VkInstance instance, long pCreateInfo, long pAllocator, long pSurface)

Unsafe version of: CreateWaylandSurfaceKHR

vkCreateWaylandSurfaceKHRback to summary
public static int vkCreateWaylandSurfaceKHR(VkInstance instance, VkWaylandSurfaceCreateInfoKHR pCreateInfo, VkAllocationCallbacks pAllocator, LongBuffer pSurface)

Create a VkSurfaceKHR object for a Wayland window.

C Specification

To create a VkSurfaceKHR object for a Wayland surface, call:


VkResult vkCreateWaylandSurfaceKHR(
    VkInstance                                  instance,
    const VkWaylandSurfaceCreateInfoKHR*        pCreateInfo,
    const VkAllocationCallbacks*                pAllocator,
    VkSurfaceKHR*                               pSurface);
Valid Usage (Implicit)
  • instance must be a valid VkInstance handle
  • pCreateInfo must be a valid pointer to a valid VkWaylandSurfaceCreateInfoKHR structure
  • If pAllocator is not NULL, pAllocator must be a valid pointer to a valid VkAllocationCallbacks structure
  • pSurface must be a valid pointer to a VkSurfaceKHR handle
Return Codes
On success, this command returns
On failure, this command returns
See Also

VkAllocationCallbacks, VkWaylandSurfaceCreateInfoKHR

Parameters
instance:VkInstance

the instance to associate the surface with.

pCreateInfo:VkWaylandSurfaceCreateInfoKHR

a pointer to a VkWaylandSurfaceCreateInfoKHR structure containing parameters affecting the creation of the surface object.

pAllocator:VkAllocationCallbacks

the allocator used for host memory allocated for the surface object when there is no more specific allocator available (see Memory Allocation).

pSurface:LongBuffer

a pointer to a VkSurfaceKHR handle in which the created surface object is returned.

Annotations
@NativeType:VkResult
vkCreateWaylandSurfaceKHRback to summary
public static int vkCreateWaylandSurfaceKHR(VkInstance instance, VkWaylandSurfaceCreateInfoKHR pCreateInfo, VkAllocationCallbacks pAllocator, long[] pSurface)

Array version of: CreateWaylandSurfaceKHR

Annotations
@NativeType:VkResult
vkGetPhysicalDeviceWaylandPresentationSupportKHRback to summary
public static boolean vkGetPhysicalDeviceWaylandPresentationSupportKHR(VkPhysicalDevice physicalDevice, int queueFamilyIndex, long display)

Query physical device for presentation to Wayland.

C Specification

To determine whether a queue family of a physical device supports presentation to a Wayland compositor, call:


VkBool32 vkGetPhysicalDeviceWaylandPresentationSupportKHR(
    VkPhysicalDevice                            physicalDevice,
    uint32_t                                    queueFamilyIndex,
    struct wl_display*                          display);
Description

This platform-specific function can be called prior to creating a surface.

Valid Usage
  • queueFamilyIndex must be less than pQueueFamilyPropertyCount returned by vkGetPhysicalDeviceQueueFamilyProperties for the given physicalDevice
Valid Usage (Implicit)
  • physicalDevice must be a valid VkPhysicalDevice handle
  • display must be a valid pointer to a wl_display value
Parameters
physicalDevice:VkPhysicalDevice

the physical device.

queueFamilyIndex:int

the queue family index.

display:long

a pointer to the wl_display associated with a Wayland compositor.

Annotations
@NativeType:VkBool32