Skip to content

Commit ab084f9

Browse files
authored
Group or shorten the names of some API specification sections (KhronosGroup#1250)
As discussed in teleconferences, the unification of the API specification has led to some long-winded and/or redundant section headers. Here are a few proposed changes that I find make the unified specification easier to navigate. Change-Id: I326f4195e5585a821d38f128bbc9d300f490631f Signed-off-by: Kevin Petit <kevin.petit@arm.com>
1 parent 507f5a3 commit ab084f9

File tree

1 file changed

+20
-24
lines changed

1 file changed

+20
-24
lines changed

api/opencl_runtime_layer.asciidoc

Lines changed: 20 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -1704,10 +1704,11 @@ include::{generated}/api/version-notes/CL_MAP_WRITE_INVALIDATE_REGION.asciidoc[]
17041704
|====
17051705
--
17061706

1707+
ifdef::cl_khr_d3d10_sharing,cl_khr_d3d11_sharing[]
1708+
=== Creating Buffer Objects From Direct3D Buffer Resources
1709+
endif::cl_khr_d3d10_sharing,cl_khr_d3d11_sharing[]
17071710

17081711
ifdef::cl_khr_d3d10_sharing[]
1709-
=== Creating OpenCL Buffer Objects From Direct3D 10 Buffer Resources
1710-
17111712
[open,refpage='clCreateFromD3D10BufferKHR',desc='Create OpenCL buffer object from a Direct3D 10 buffer',type='protos']
17121713
--
17131714
To create an OpenCL buffer object from a Direct3D 10 buffer, call the
@@ -1763,8 +1764,6 @@ endif::cl_khr_d3d10_sharing[]
17631764

17641765

17651766
ifdef::cl_khr_d3d11_sharing[]
1766-
=== Creating OpenCL Buffer Objects From Direct3D 11 Buffer Resources
1767-
17681767
[open,refpage='clCreateFromD3D11BufferKHR',desc='Create OpenCL buffer object from a Direct3D 11 buffer',type='protos']
17691768
--
17701769
To create an OpenCL buffer object from a Direct3D 11 buffer, call the
@@ -1820,7 +1819,7 @@ endif::cl_khr_d3d11_sharing[]
18201819

18211820

18221821
ifdef::cl_khr_gl_sharing[]
1823-
=== Creating OpenCL Buffer Objects From OpenGL Buffer Objects
1822+
=== Creating Buffer Objects From OpenGL Buffer Objects
18241823

18251824
[open,refpage='clCreateFromGLBuffer',desc='Create OpenCL buffer object from an OpenGL buffer object',type='protos']
18261825
--
@@ -4364,7 +4363,7 @@ endif::cl_khr_d3d11_sharing[]
43644363

43654364

43664365
ifdef::cl_khr_dx9_media_sharing[]
4367-
=== Creating OpenCL Image Objects From DirectX 9 Media Resources
4366+
=== Creating Image Objects From DirectX 9 Media Resources
43684367

43694368
[open,refpage='clCreateFromDX9MediaSurfaceKHR',desc='Create OpenCL image object from a media surface',type='protos']
43704369
--
@@ -4464,9 +4463,11 @@ performance.
44644463
endif::cl_khr_dx9_media_sharing[]
44654464

44664465

4467-
ifdef::cl_khr_d3d10_sharing[]
4468-
=== Creating OpenCL Image Objects From Direct3D 10 Textures and Resources
4466+
ifdef::cl_khr_d3d10_sharing,cl_khr_d3d11_sharing[]
4467+
=== Creating Image Objects From Direct3D Textures and Resources
4468+
endif::cl_khr_d3d10_sharing,cl_khr_d3d11_sharing[]
44694469

4470+
ifdef::cl_khr_d3d10_sharing[]
44704471
[open,refpage='clCreateFromD3D10Texture2DKHR',desc='Create OpenCL 2D image object from a Direct3D 10 2D texture',type='protos']
44714472
--
44724473
To create an OpenCL 2D image object from a subresource of a Direct3D 10 2D
@@ -4599,8 +4600,6 @@ endif::cl_khr_d3d10_sharing[]
45994600

46004601

46014602
ifdef::cl_khr_d3d11_sharing[]
4602-
=== Creating OpenCL Image Objects From Direct3D 11 Textures and Resources
4603-
46044603
[open,refpage='clCreateFromD3D11Texture2DKHR',desc='Create OpenCL 2D image object from a Direct3D 11 2D texture',type='protos']
46054604
--
46064605
To create an OpenCL 2D image object from a subresource of a Direct3D 11 2D
@@ -4733,7 +4732,7 @@ endif::cl_khr_d3d11_sharing[]
47334732

47344733

47354734
ifdef::cl_khr_egl_image[]
4736-
=== Creating OpenCL Image Objects From EGL Images
4735+
=== Creating Image Objects From EGL Images
47374736

47384737
[open,refpage='clCreateFromEGLImageKHR',desc='Create cl_mem target from EGLImage source',type='protos']
47394738
--
@@ -4812,7 +4811,7 @@ endif::cl_khr_egl_image[]
48124811

48134812

48144813
ifdef::cl_khr_gl_sharing[]
4815-
=== Creating OpenCL Image Objects From OpenGL Textures and Renderbuffers
4814+
=== Creating Image Objects From OpenGL Textures and Renderbuffers
48164815

48174816
[open,refpage='clCreateFromGLTexture',desc='Create OpenCL image object from an OpenGL texture object',type='protos']
48184817
--
@@ -5240,10 +5239,7 @@ include::{generated}/api/version-notes/CL_PIPE_PROPERTIES.asciidoc[]
52405239
--
52415240

52425241

5243-
== Querying, Unmapping, Migrating, Retaining and Releasing Memory Objects
5244-
5245-
// === Handling Memory Objects
5246-
5242+
== Memory Objects
52475243

52485244
=== Retaining and Releasing Memory Objects
52495245

@@ -6210,18 +6206,18 @@ and {clGetImageInfo} with _param_name_ {CL_MEM_DX9_MEDIA_ADAPTER_TYPE_KHR},
62106206
endif::cl_khr_dx9_media_sharing[]
62116207

62126208

6213-
ifdef::cl_khr_d3d10_sharing[]
6214-
=== Querying Direct3D Properties of Memory Objects Created From Direct3D 10 Resources
6209+
ifdef::cl_khr_d3d10_sharing,cl_khr_d3d11_sharing[]
6210+
=== Querying Direct3D Properties of Memory Objects Created From Direct3D Resources
6211+
endif::cl_khr_d3d10_sharing,cl_khr_d3d11_sharing[]
62156212

6213+
ifdef::cl_khr_d3d10_sharing[]
62166214
Properties of Direct3D 10 objects may be queried using {clGetMemObjectInfo}
62176215
and {clGetImageInfo} with _param_name_ {CL_MEM_D3D10_RESOURCE_KHR} and
62186216
{CL_IMAGE_D3D10_SUBRESOURCE_KHR} respectively.
62196217
endif::cl_khr_d3d10_sharing[]
62206218

62216219

62226220
ifdef::cl_khr_d3d11_sharing[]
6223-
=== Querying Direct3D Properties of Memory Objects Created From Direct3D 11 Resources
6224-
62256221
Properties of Direct3D 11 objects may be queried using {clGetMemObjectInfo}
62266222
and {clGetImageInfo} with _param_name_ {CL_MEM_D3D11_RESOURCE_KHR} and
62276223
{CL_IMAGE_D3D11_SUBRESOURCE_KHR} respectively.
@@ -6508,9 +6504,11 @@ Otherwise it returns one of the following errors:
65086504
endif::cl_khr_dx9_media_sharing[]
65096505

65106506

6511-
ifdef::cl_khr_d3d10_sharing[]
6512-
=== Sharing Memory Objects Created From Direct3D 10 Resources Between Direct3D 10 and OpenCL Contexts
6507+
ifdef::cl_khr_d3d10_sharing,cl_khr_d3d11_sharing[]
6508+
=== Sharing Memory Objects Created From Direct3D Resources Between Direct3D and OpenCL Contexts
6509+
endif::cl_khr_d3d10_sharing,cl_khr_d3d11_sharing[]
65136510

6511+
ifdef::cl_khr_d3d10_sharing[]
65146512
[open,refpage='clEnqueueAcquireD3D10ObjectsKHR',desc='Acquire OpenCL memory objects created from Direct3D 10 resources',type='protos']
65156513
--
65166514
To acquire OpenCL memory objects that have been created from Direct3D 10
@@ -6681,8 +6679,6 @@ endif::cl_khr_d3d10_sharing[]
66816679

66826680

66836681
ifdef::cl_khr_d3d11_sharing[]
6684-
=== Sharing Memory Objects Created From Direct3D 11 Resources Between Direct3D 11 and OpenCL Contexts
6685-
66866682
[open,refpage='clEnqueueAcquireD3D11ObjectsKHR',desc='Acquire OpenCL memory objects created from Direct3D 11 resources',type='protos']
66876683
--
66886684
To acquire OpenCL memory objects that have been created from Direct3D 11

0 commit comments

Comments
 (0)