CLCREATEFROMD3D10BUF(3clc)

📦
version 1.0~svn33624 · 3 versions
, in ubuntu jammy, ubuntu noble

💖 CLCREATEFROMD3D10BUF 💖

okay bestie, welcome to the OpenCL Manual ✨ this one's CLCREATEFROMD3D10BUF(3clc) and it's all about yeeting a Direct3D 10 buffer into OpenCL-land. no cap.

🌸 NAME 🌸

clCreateFromD3D10BufferKHR — creates an OpenCL buffer object from a Direct3D 10 buffer. that's it, that's the whole job 💅

cl_mem clCreateFromD3D10BufferKHR(cl_context context,
                                  cl_mem_flags flags,
                                  ID3D10Buffer *resource,
                                  cl_int *errcode_ret);

🎀 PARAMETERS 🎀

  • context — a valid OpenCL context that was created from a Direct3D 10 device. like, it has to come from a D3D10 device, no substitutes 🫶
  • flags — a bit-field for usage info. it may be CL_MEM_READ_ONLY, CL_MEM_WRITE_ONLY, or CL_MEM_READ_WRITE. (go peek at the table in clCreateBuffer(3clc) if you want the full tea ☕)
  • resource — a pointer to the Direct3D 10 buffer you wanna share. the actual D3D10 thing.
  • errcode_ret — an appropriate error code lands here. if errcode_ret is NULL, no error code gets returned at all. ghosted 😭

✨ NOTES ✨

the size of the returned OpenCL buffer object is the same as the size of resource. not a lil bit bigger, not a lil bit smaller. same. 🔥

this call will increment the internal Direct3D reference count on resource. and that internal Direct3D reference count on resource gets decremented when the OpenCL reference count on the returned OpenCL memory object drops to zero. balanced, like it should be 💖

general info about sharing memory objects with Direct3D 10, incoming:

the goal of this extension is to provide interoperability between OpenCL and Direct3D 10. it's designed to function analogously to the OpenGL interoperability. if this extension is supported by an implementation, the string "cl_khr_d3d10_sharing" will be present in the CL_PLATFORM_EXTENSIONS or CL_DEVICE_EXTENSIONS string described in the table of allowed values for param_name for clGetDeviceInfo(3clc). so like, that's your vibe check 👑

as currently proposed, the interfaces for this extension would be provided in cl_d3d10.h.

this section discusses OpenCL functions that let applications use Direct3D 10 resources as OpenCL memory objects. this allows efficient sharing of data between OpenCL and Direct3D 10. the OpenCL API may be used to execute kernels that read and/or write memory objects that are also Direct3D 10 resources. an OpenCL image object may be created from a Direct3D 10 texture resource. an OpenCL buffer object may be created from a Direct3D 10 buffer resource. OpenCL memory objects may be created from Direct3D 10 objects if and only if the OpenCL context has been created from a Direct3D 10 device. that's the rule, periodt.

Lifetime of Shared Objects.

(the original page literally has a stray .PP jammed in right here, troff gremlins got in 💀 but the heading is real and so is what follows)

an OpenCL memory object created from a Direct3D 10 resource remains valid as long as the corresponding Direct3D 10 resource has not been deleted. if the Direct3D 10 resource is deleted through the Direct3D 10 API, subsequent use of the OpenCL memory object will result in undefined behavior, including but not limited to possible OpenCL errors, data corruption, and program termination. so like... don't do that. fr fr. 🚨

the successful creation of a cl_context against a Direct3D 10 device specified via the context create parameter CL_CONTEXT_D3D10_DEVICE_KHR will increment the internal Direct3D reference count on the specified Direct3D 10 device. the internal Direct3D reference count on that Direct3D 10 device will be decremented when the OpenCL reference count on the returned OpenCL context drops to zero. symmetry, we love to see it ✨

the OpenCL context and corresponding command-queues are dependent on the existence of the Direct3D 10 device from which the OpenCL context was created. if the Direct3D 10 device is deleted through the Direct3D 10 API, subsequent use of the OpenCL context will result in undefined behavior, including but not limited to possible OpenCL errors, data corruption, and program termination. same warning, different object. both of them will ruin your whole day 🌈

🦋 ERRORS 🦋

returns CL_SUCCESS returns a valid non-zero OpenCL buffer object and errcode_ret is set to CL_SUCCESS if the buffer object is created successfully. otherwise, it returns a NULL value with one of the following error values returned in errcode_ret:

  • CL_INVALID_CONTEXT if context is not a valid context. 🙈
  • CL_INVALID_VALUE if values specified in flags are not valid. 💀
  • CL_INVALID_D3D10_RESOURCE_KHR if resource is not a Direct3D 10 buffer resource, if resource was created with the D3D10_USAGE flag D3D10_USAGE_IMMUTABLE, if a cl_mem from resource has already been created using clCreateFromD3D10BufferKHR, or if context was not created against the same Direct3D 10 device from which resource was created. (that's a lot of ways to fail, bestie, count them all 😭)
  • CL_OUT_OF_HOST_MEMORY if there is a failure to allocate resources required by the OpenCL implementation on the host. 🍓

📜 SPECIFICATION 📜

OpenCL Specification[1]

👀 SEE ALSO 👀

go read those next, iykyk 💜

🫶 AUTHORS 🫶

The Khronos Group

Copyright © 2007-2011 The Khronos Group Inc.

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and/or associated documentation files (the "Materials"), to deal in the Materials without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Materials, and to permit persons to whom the Materials are furnished to do so, subject to the condition that this copyright notice and permission notice shall be included in all copies or substantial portions of the Materials.

📝 NOTES (the footnote kind) 📝

  1. OpenCL Specification page 73, section 9.9.7.3 - Sharing Direct3D 10 Buffer Resources as OpenCL...

and that's the whole page, bestie 🎀 this lil manual page is brought to you by The Khronos Group, dated 01/14/2021, and it ate, no crumbs. now go forth and share your buffers responsibly, main character 💅✨🦋

📦 where this page comes from