• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1// Copyright 2014-2021 The Khronos Group, Inc.
2//
3// SPDX-License-Identifier: CC-BY-4.0
4
5[[platformCreateSurface_directfb,platformCreateSurface_directfb]]
6
7=== DirectFB Platform
8
9[open,refpage='vkCreateDirectFBSurfaceEXT',desc='Create a slink:VkSurfaceKHR object for a DirectFB surface',type='protos']
10--
11To create a sname:VkSurfaceKHR object for a DirectFB surface, call:
12
13include::{generated}/api/protos/vkCreateDirectFBSurfaceEXT.txt[]
14
15  * pname:instance is the instance to associate the surface with.
16  * pname:pCreateInfo is a pointer to a sname:VkDirectFBSurfaceCreateInfoEXT
17    structure containing parameters affecting the creation of the surface
18    object.
19  * pname:pAllocator is the allocator used for host memory allocated for the
20    surface object when there is no more specific allocator available (see
21    <<memory-allocation,Memory Allocation>>).
22  * pname:pSurface is a pointer to a slink:VkSurfaceKHR handle in which the
23    created surface object is returned.
24
25include::{generated}/validity/protos/vkCreateDirectFBSurfaceEXT.txt[]
26--
27
28[open,refpage='VkDirectFBSurfaceCreateInfoEXT',desc='Structure specifying parameters of a newly created DirectFB surface object',type='structs']
29--
30The sname:VkDirectFBSurfaceCreateInfoEXT structure is defined as:
31
32include::{generated}/api/structs/VkDirectFBSurfaceCreateInfoEXT.txt[]
33
34  * pname:sType is the type of this structure.
35  * pname:pNext is `NULL` or a pointer to a structure extending this
36    structure.
37  * pname:flags is reserved for future use.
38  * pname:dfb is a pointer to the code:IDirectFB main interface of DirectFB.
39  * pname:surface is a pointer to a code:IDirectFBSurface surface interface.
40
41.Valid Usage
42****
43  * [[VUID-VkDirectFBSurfaceCreateInfoEXT-dfb-04117]]
44    pname:dfb must: point to a valid DirectFB code:IDirectFB
45  * [[VUID-VkDirectFBSurfaceCreateInfoEXT-surface-04118]]
46    pname:surface must: point to a valid DirectFB code:IDirectFBSurface
47****
48
49include::{generated}/validity/structs/VkDirectFBSurfaceCreateInfoEXT.txt[]
50--
51
52With DirectFB, pname:minImageExtent, pname:maxImageExtent, and
53pname:currentExtent must: always equal the surface size.
54
55[open,refpage='VkDirectFBSurfaceCreateFlagsEXT',desc='Reserved for future use',type='flags']
56--
57include::{generated}/api/flags/VkDirectFBSurfaceCreateFlagsEXT.txt[]
58
59tname:VkDirectFBSurfaceCreateFlagsEXT is a bitmask type for setting a mask,
60but is currently reserved for future use.
61--
62