Top Description Fields Constructors Methods
org.lwjgl.vulkan

public Class EXTDirectfbSurface

extends Object
Class Inheritance
Imports
javax.annotation.*, java.nio.*, org.lwjgl.system.*
The VK_EXT_directfb_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 DirectFB IDirectFBSurface, as well as a query to determine support for rendering via DirectFB.
VK_EXT_directfb_surface
Name String
VK_EXT_directfb_surface
Extension Type
Instance extension
Registered Extension Number
347
Revision
1
Extension and Version Dependencies
VK_KHR_surface
Contact
Other Extension Metadata
Last Modified Date
2020-06-16
IP Status
No known IP claims.
Contributors
  • Nicolas Caramelli

Field Summary

Modifier and TypeField and Description
public static final String
VK_EXT_DIRECTFB_SURFACE_EXTENSION_NAME

The extension name.

public static final int
VK_EXT_DIRECTFB_SURFACE_SPEC_VERSION

The extension specification version.

public static final int
VK_STRUCTURE_TYPE_DIRECTFB_SURFACE_CREATE_INFO_EXT

Extends VkStructureType.

Constructor Summary

AccessConstructor and Description
protected
EXTDirectfbSurface()

Method Summary

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

Unsafe version of: CreateDirectFBSurfaceEXT

public static int
vkCreateDirectFBSurfaceEXT(VkInstance
the instance to associate the surface with.
instance, VkDirectFBSurfaceCreateInfoEXT
a pointer to a VkDirectFBSurfaceCreateInfoEXT 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 DirectFB surface.

public static int
vkCreateDirectFBSurfaceEXT(VkInstance instance, VkDirectFBSurfaceCreateInfoEXT pCreateInfo, VkAllocationCallbacks pAllocator, long[] pSurface)

Array version of: CreateDirectFBSurfaceEXT

public static boolean
vkGetPhysicalDeviceDirectFBPresentationSupportEXT(VkPhysicalDevice
the physical device.
physicalDevice, int
the queue family index.
queueFamilyIndex, long
a pointer to the IDirectFB main interface of DirectFB.
dfb)

Query physical device for presentation with DirectFB.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

VK_EXT_DIRECTFB_SURFACE_EXTENSION_NAMEback to summary
public static final String VK_EXT_DIRECTFB_SURFACE_EXTENSION_NAME

The extension name.

VK_EXT_DIRECTFB_SURFACE_SPEC_VERSIONback to summary
public static final int VK_EXT_DIRECTFB_SURFACE_SPEC_VERSION

The extension specification version.

VK_STRUCTURE_TYPE_DIRECTFB_SURFACE_CREATE_INFO_EXTback to summary
public static final int VK_STRUCTURE_TYPE_DIRECTFB_SURFACE_CREATE_INFO_EXT

Extends VkStructureType.

Constructor Detail

EXTDirectfbSurfaceback to summary
protected EXTDirectfbSurface()

Method Detail

nvkCreateDirectFBSurfaceEXTback to summary
public static int nvkCreateDirectFBSurfaceEXT(VkInstance instance, long pCreateInfo, long pAllocator, long pSurface)

Unsafe version of: CreateDirectFBSurfaceEXT

vkCreateDirectFBSurfaceEXTback to summary
public static int vkCreateDirectFBSurfaceEXT(VkInstance instance, VkDirectFBSurfaceCreateInfoEXT pCreateInfo, VkAllocationCallbacks pAllocator, LongBuffer pSurface)

Create a VkSurfaceKHR object for a DirectFB surface.

C Specification

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


VkResult vkCreateDirectFBSurfaceEXT(
    VkInstance                                  instance,
    const VkDirectFBSurfaceCreateInfoEXT*       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 VkDirectFBSurfaceCreateInfoEXT 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, VkDirectFBSurfaceCreateInfoEXT

Parameters
instance:VkInstance

the instance to associate the surface with.

pCreateInfo:VkDirectFBSurfaceCreateInfoEXT

a pointer to a VkDirectFBSurfaceCreateInfoEXT 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
vkCreateDirectFBSurfaceEXTback to summary
public static int vkCreateDirectFBSurfaceEXT(VkInstance instance, VkDirectFBSurfaceCreateInfoEXT pCreateInfo, VkAllocationCallbacks pAllocator, long[] pSurface)

Array version of: CreateDirectFBSurfaceEXT

Annotations
@NativeType:VkResult
vkGetPhysicalDeviceDirectFBPresentationSupportEXTback to summary
public static boolean vkGetPhysicalDeviceDirectFBPresentationSupportEXT(VkPhysicalDevice physicalDevice, int queueFamilyIndex, long dfb)

Query physical device for presentation with DirectFB.

C Specification

To determine whether a queue family of a physical device supports presentation with DirectFB library, call:


VkBool32 vkGetPhysicalDeviceDirectFBPresentationSupportEXT(
    VkPhysicalDevice                            physicalDevice,
    uint32_t                                    queueFamilyIndex,
    IDirectFB*                                  dfb);
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
  • dfb must be a valid pointer to an IDirectFB value
Parameters
physicalDevice:VkPhysicalDevice

the physical device.

queueFamilyIndex:int

the queue family index.

dfb:long

a pointer to the IDirectFB main interface of DirectFB.

Annotations
@NativeType:VkBool32