clEnqueueAcquireDX9MediaSurfacesKHR - Acquire OpenCL memory objects that have been created from a media

TheKhronosGroup

       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.

       Returns CL_SUCCESS returns CL_SUCCESS if the function is executed successfully. If num_objects is 0 and
       mem_objects is NULL then the function does nothing and returns CL_SUCCESS. Otherwise it returns one of
       the following errors:

       •   CL_INVALID_VALUE if num_objects is zero and mem_objects is not a NULL value or if num_objects > 0 and
           mem_objects is NULL.

       •   CL_INVALID_MEM_OBJECT if memory objects in mem_objects are not valid OpenCL memory objects or if
           memory objects in mem_objects have not been created from media surfaces.

       •   CL_INVALID_COMMAND_QUEUE if command_queue is not a valid command-queue.

       •   CL_INVALID_CONTEXT if context associated with command_queue was not created from a device that can
           share the media surface referenced by mem_objects.

       •   CL_DX9_MEDIA_SURFACE_ALREADY_ACQUIRED_KHR if memory objects in mem_objects  have previously been
           acquired using clEnqueueAcquireDX9MediaSurfacesKHR but have not been released using
           clEnqueueReleaseDX9MediaSurfacesKHR(3clc).

       •   CL_INVALID_EVENT_WAIT_LIST if event_wait_list is NULL and num_event_in_wait_list > 0, or
           event_wait_list is  not NULL and num_event_in_wait_list is 0, or if event objects in event_wait_list
           are not valid events.

       •   CL_OUT_OF_HOST_MEMORY if there is a failure to allocate resources required by the OpenCL
           implementation on the host.

       clEnqueueAcquireDX9MediaSurfacesKHR - Acquire OpenCL memory objects that have been created from a media
       surface.

       cl_intclEnqueueAcquireDX9MediaSurfacesKHR(cl_command_queuecommand_queue,cl_uintnum_objects,constcl_mem*mem_objects,cl_uintnum_events_in_wait_list,constcl_event*event_wait_list,cl_event*event);

        1. OpenCL Specification
           page 92, section 9.10.7.4 - Sharing Memory Objects created from Media Surfaces

The Khronos Group                                  11/18/2024                         CLENQUEUEACQUIREDX9M(3clc)

command_queue
           A valid command-queue.

       num_objects
           The number of memory objects to be acquired in mem_objects.

       mem_objects
           A pointer to a list of OpenCL memory objects that were created from media surfaces.

       num_events_in_wait_list, event_wait_list
           Specify events that need to complete before this particular command can be executed. If
           event_wait_list is NULL, then this particular command does not wait on any event to complete. If
           event_wait_list is NULL, num_events_in_wait_list must be 0. If event_wait_list is not NULL, the list
           of events pointed to by event_wait_list must be valid and num_events_in_wait_list must be greater
           than 0. The events specified in event_wait_list act as synchronization points.

       event
           Returns n event object that identifies this particular command and can be used to query or queue a
           wait for this particular command to complete.  event can be NULL in which case it will not be
           possible for the application to query the status of this command or queue a wait for this command to
           complete.

cl_khr_dx9_media_sharing(3clc), clGetDeviceIDsFromDX9MediaAdapterKHR(3clc),
       clCreateFromDX9MediaSurfaceKHR(3clc), clEnqueueReleaseDX9MediaSurfacesKHR(3clc),
       clEnqueueAcquireDX9MediaSurfacesKHR(3clc)

OpenCLSpecification[1]