info Please note that this product is now discontinued and product support has ceased. For more information, please read the blog

menu_bookReference

history2.11.0
  1. Classes
    1. N
      cl
      1. N
        sycl
        1. S
          hash< cl::sycl::accessor< elemT, kDims, kMode, kTarget, isPlaceholder > >
          1. N
            info
            1. N
              property
              1. C
                device_selector
                1. C
                  accessor< elemT, 0, kMode, access::target::local, access::placeholder::false_t >
                  1. C
                    accessor< elemT, kDims, kMode, access::target::host_image, access::placeholder::false_t >
                    1. C
                      accessor< elemT, kDims, kMode, access::target::image, access::placeholder::false_t >
                      1. C
                        accessor< elemT, kDims, kMode, access::target::local, access::placeholder::false_t >
                        1. C
                          accessor_error
                          1. S
                            atomic
                            1. C
                              backend_traits< backend::opencl >
                              1. C
                                buffer< const T, dims, AllocatorT >
                                1. C
                                  context
                                  1. C
                                    default_selector
                                    1. C
                                      device_error
                                      1. S
                                        device_type
                                        1. C
                                          event
                                          1. C
                                            exception
                                            1. C
                                              feature_not_supported
                                              1. C
                                                group
                                                1. C
                                                  handler
                                                  1. C
                                                    id
                                                    1. S
                                                      info_convert< cl_context *, context >
                                                      1. S
                                                        info_convert< cl_platform_id *, platform >
                                                        1. C
                                                          intel_selector
                                                          1. C
                                                            invalid_parameter_error
                                                            1. C
                                                              kernel
                                                              1. C
                                                                link_program_error
                                                                1. C
                                                                  multi_ptr
                                                                  1. C
                                                                    multi_ptr< void, asp >
                                                                    1. C
                                                                      nd_range
                                                                      1. C
                                                                        opencl_selector
                                                                        1. C
                                                                          platform_error
                                                                          1. C
                                                                            private_memory
                                                                            1. C
                                                                              profiling_error
                                                                              1. C
                                                                                property_list
                                                                                1. C
                                                                                  range
                                                                                  1. C
                                                                                    sampler
                                                                                    1. S
                                                                                      stream_vec
                                                                                      1. S
                                                                                        stream_vec< 2, true, elementT, kDimensions >
                                                                                        1. S
                                                                                          stream_vec< 4, true, elementT, kDimensions >
                                                                                          1. C
                                                                                            swizzled_vec
                                                                                          2. S
                                                                                            hash< cl::sycl::context >
                                                                                            1. S
                                                                                              hash< cl::sycl::event >
                                                                                              1. S
                                                                                                hash< cl::sycl::kernel >
                                                                                                1. S
                                                                                                  hash< cl::sycl::program >
                                                                                                  1. S
                                                                                                    hash< cl::sycl::sampler >
                                                                                                  2. N
                                                                                                    codeplay
                                                                                                    1. N
                                                                                                      profiling
                                                                                                      1. N
                                                                                                        property
                                                                                                        1. C
                                                                                                          handler
                                                                                                          1. C
                                                                                                            interop_handle
                                                                                                            1. S
                                                                                                              maximum
                                                                                                              1. S
                                                                                                                maximum< void >
                                                                                                                1. S
                                                                                                                  minimum< void >
                                                                                                                  1. C
                                                                                                                    no_init_impl
                                                                                                                  2. C
                                                                                                                    profiling_zone
                                                                                                                    1. C
                                                                                                                      host_access
                                                                                                                    2. N
                                                                                                                      buffer
                                                                                                                      1. C
                                                                                                                        use_onchip_memory
                                                                                                                        1. C
                                                                                                                          host_handler
                                                                                                                          1. S
                                                                                                                            rebind
                                                                                                                            1. C
                                                                                                                              context_bound
                                                                                                                              1. C
                                                                                                                                use_mutex
                                                                                                                                1. C
                                                                                                                                  enable_profiling
                                                                                                                                2. N
                                                                                                                                  experimental
                                                                                                                                  1. S
                                                                                                                                    sub_group
                                                                                                                                    1. S
                                                                                                                                      minimum
                                                                                                                                      1. C
                                                                                                                                        usm_allocator
                                                                                                                                        1. N
                                                                                                                                          ext
                                                                                                                                          1. S
                                                                                                                                            param_traits
                                                                                                                                            1. N
                                                                                                                                              buffer
                                                                                                                                              1. C
                                                                                                                                                use_host_ptr
                                                                                                                                                1. N
                                                                                                                                                  queue
                                                                                                                                                  1. C
                                                                                                                                                    in_order_impl
                                                                                                                                                    1. C
                                                                                                                                                      accelerator_selector
                                                                                                                                                      1. C
                                                                                                                                                        accessor
                                                                                                                                                        1. C
                                                                                                                                                          accessor< elemT, kDims, kMode, access::target::host_buffer, access::placeholder::false_t >
                                                                                                                                                          1. C
                                                                                                                                                            accessor< elemT, kDims, kMode, access::target::host_task, IsPlaceholder >
                                                                                                                                                            1. C
                                                                                                                                                              accessor< elemT, kDims, kMode, access::target::image_array, access::placeholder::false_t >
                                                                                                                                                              1. C
                                                                                                                                                                accessor< elemT, kDims, kMode, access::target::subgroup_local, access::placeholder::false_t >
                                                                                                                                                                1. C
                                                                                                                                                                  amd_selector
                                                                                                                                                                  1. C
                                                                                                                                                                    backend_traits
                                                                                                                                                                    1. C
                                                                                                                                                                      buffer
                                                                                                                                                                      1. C
                                                                                                                                                                        compile_program_error
                                                                                                                                                                        1. C
                                                                                                                                                                          cpu_selector
                                                                                                                                                                          1. C
                                                                                                                                                                            device
                                                                                                                                                                            1. C
                                                                                                                                                                              device_event
                                                                                                                                                                              1. S
                                                                                                                                                                                elem
                                                                                                                                                                                1. C
                                                                                                                                                                                  event_error
                                                                                                                                                                                  1. C
                                                                                                                                                                                    exception_list
                                                                                                                                                                                    1. C
                                                                                                                                                                                      gpu_selector
                                                                                                                                                                                      1. C
                                                                                                                                                                                        h_item
                                                                                                                                                                                        1. C
                                                                                                                                                                                          host_selector
                                                                                                                                                                                          1. C
                                                                                                                                                                                            image
                                                                                                                                                                                            1. S
                                                                                                                                                                                              info_convert< cl_device_id *, device >
                                                                                                                                                                                              1. S
                                                                                                                                                                                                info_convert< size_t *, range< 3 > >
                                                                                                                                                                                                1. C
                                                                                                                                                                                                  invalid_object_error
                                                                                                                                                                                                  1. C
                                                                                                                                                                                                    item
                                                                                                                                                                                                    1. C
                                                                                                                                                                                                      kernel_error
                                                                                                                                                                                                      1. C
                                                                                                                                                                                                        memory_allocation_error
                                                                                                                                                                                                        1. C
                                                                                                                                                                                                          multi_ptr< const void, asp >
                                                                                                                                                                                                          1. C
                                                                                                                                                                                                            nd_item
                                                                                                                                                                                                            1. C
                                                                                                                                                                                                              nd_range_error
                                                                                                                                                                                                              1. C
                                                                                                                                                                                                                platform
                                                                                                                                                                                                                1. C
                                                                                                                                                                                                                  precision_manipulator
                                                                                                                                                                                                                  1. C
                                                                                                                                                                                                                    handler::parallel_for_work_group
                                                                                                                                                                                                                    1. C
                                                                                                                                                                                                                      program
                                                                                                                                                                                                                      1. C
                                                                                                                                                                                                                        queue
                                                                                                                                                                                                                        1. C
                                                                                                                                                                                                                          runtime_error
                                                                                                                                                                                                                          1. C
                                                                                                                                                                                                                            stream
                                                                                                                                                                                                                            1. S
                                                                                                                                                                                                                              stream_vec< 16, true, elementT, kDimensions >
                                                                                                                                                                                                                              1. S
                                                                                                                                                                                                                                stream_vec< 3, true, elementT, kDimensions >
                                                                                                                                                                                                                                1. S
                                                                                                                                                                                                                                  stream_vec< 8, true, elementT, kDimensions >
                                                                                                                                                                                                                                  1. C
                                                                                                                                                                                                                                    vec
                                                                                                                                                                                                                                    1. S
                                                                                                                                                                                                                                      hash< cl::sycl::buffer< T, dimensions, AllocatorT > >
                                                                                                                                                                                                                                      1. S
                                                                                                                                                                                                                                        hash< cl::sycl::device >
                                                                                                                                                                                                                                        1. S
                                                                                                                                                                                                                                          hash< cl::sycl::image< kDimensions, AllocatorT > >
                                                                                                                                                                                                                                          1. S
                                                                                                                                                                                                                                            hash< cl::sycl::platform >
                                                                                                                                                                                                                                            1. S
                                                                                                                                                                                                                                              hash< cl::sycl::queue >
                                                                                                                                                                                                                                              1. S
                                                                                                                                                                                                                                                hash< cl::sycl::stream >

                                                                                                                                                                                                                                              cl::sycl::platform Class Reference

                                                                                                                                                                                                                                              Interface for abstracting and interacting with an underlying cl_platform_id object. More...

                                                                                                                                                                                                                                              #include <platform.h>

                                                                                                                                                                                                                                              Public Member Functions

                                                                                                                                                                                                                                               platform ()
                                                                                                                                                                                                                                               Default Constructor. More...
                                                                                                                                                                                                                                               
                                                                                                                                                                                                                                               platform (cl_platform_id platformID)
                                                                                                                                                                                                                                               Constructs a platform object using a cl_platform_id object. More...
                                                                                                                                                                                                                                               
                                                                                                                                                                                                                                               platform (const platform &rhs)=default
                                                                                                                                                                                                                                               Copy Constructor. More...
                                                                                                                                                                                                                                               
                                                                                                                                                                                                                                               platform (const cl::sycl::device_selector &deviceSelector)
                                                                                                                                                                                                                                               Constructs a platform from an existing device selector. More...
                                                                                                                                                                                                                                               
                                                                                                                                                                                                                                              platform & operator= (const platform &rhs)=default
                                                                                                                                                                                                                                               Assignment Operator. More...
                                                                                                                                                                                                                                               
                                                                                                                                                                                                                                               ~platform ()=default
                                                                                                                                                                                                                                               Destroys the implementation object. More...
                                                                                                                                                                                                                                               
                                                                                                                                                                                                                                              cl_platform_id get () const
                                                                                                                                                                                                                                               Returns the underlying cl_platform_id object. More...
                                                                                                                                                                                                                                               
                                                                                                                                                                                                                                              cl_platform_id get_no_retain () const noexcept
                                                                                                                                                                                                                                               Returns the underlying cl_platform_id object without checking if the system is host or device. More...
                                                                                                                                                                                                                                               
                                                                                                                                                                                                                                              bool is_host () const
                                                                                                                                                                                                                                               Specifies whether the platform is a host platform. More...
                                                                                                                                                                                                                                               
                                                                                                                                                                                                                                              template<info::platform param>
                                                                                                                                                                                                                                              info::param_traits< info::platform, param >::return_type get_info () const
                                                                                                                                                                                                                                               Get OpenCL information for the underlying cl_platform_id. More...
                                                                                                                                                                                                                                               
                                                                                                                                                                                                                                              bool has_extension (const char *extension) const
                                                                                                                                                                                                                                               This function avoids using strings across the ABI. More...
                                                                                                                                                                                                                                               
                                                                                                                                                                                                                                              bool has_extension (const string_class &extension) const
                                                                                                                                                                                                                                               Check whether a specific extension is supported on the platform. More...
                                                                                                                                                                                                                                               
                                                                                                                                                                                                                                              vector_class< device > get_devices (info::device_type deviceType=info::device_type::all) const
                                                                                                                                                                                                                                               Get a list of devices associated with the platform. More...
                                                                                                                                                                                                                                               
                                                                                                                                                                                                                                              dplatform_shptr get_impl () const
                                                                                                                                                                                                                                               

                                                                                                                                                                                                                                              Static Public Member Functions

                                                                                                                                                                                                                                              static vector_class< platform > get_platforms ()
                                                                                                                                                                                                                                               Get a list of all available platforms. More...
                                                                                                                                                                                                                                               

                                                                                                                                                                                                                                              Protected Member Functions

                                                                                                                                                                                                                                               platform (detail::impl_constructor_tag, const detail::device_selector_wrapper &deviceSelector)
                                                                                                                                                                                                                                               Constructs a SYCL platform object using a custom device selector callable. More...
                                                                                                                                                                                                                                               
                                                                                                                                                                                                                                              bool has_impl (aspect_impl asp) const
                                                                                                                                                                                                                                               Returns true if all of the devices associated with the platform support the specified aspect. More...
                                                                                                                                                                                                                                               

                                                                                                                                                                                                                                              Protected Attributes

                                                                                                                                                                                                                                              dplatform_shptr m_impl
                                                                                                                                                                                                                                               Implementation object. More...
                                                                                                                                                                                                                                               

                                                                                                                                                                                                                                              Friends

                                                                                                                                                                                                                                              bool operator== (const platform &lhs, const platform &rhs)
                                                                                                                                                                                                                                               Checks for equality with another platform instance. More...
                                                                                                                                                                                                                                               
                                                                                                                                                                                                                                              bool operator!= (const platform &lhs, const platform &rhs)
                                                                                                                                                                                                                                               

                                                                                                                                                                                                                                              Detailed Description

                                                                                                                                                                                                                                              Interface for abstracting and interacting with an underlying cl_platform_id object.

                                                                                                                                                                                                                                              Definition at line 104 of file platform.h.

                                                                                                                                                                                                                                              Constructor & Destructor Documentation

                                                                                                                                                                                                                                              ◆ platform() [1/5]

                                                                                                                                                                                                                                              cl::sycl::platform::platform ( )

                                                                                                                                                                                                                                              Default Constructor.

                                                                                                                                                                                                                                              Constructs a platform object containing the device returned by default_selector_v in SYCL 2020. Otherwise, constructs a host platform.

                                                                                                                                                                                                                                              ◆ platform() [2/5]

                                                                                                                                                                                                                                              cl::sycl::platform::platform ( cl_platform_id  platformID)
                                                                                                                                                                                                                                              		explicit

                                                                                                                                                                                                                                              Constructs a platform object using a cl_platform_id object.

                                                                                                                                                                                                                                              Parameters
                                                                                                                                                                                                                                              platformIDThe cl_platform_id object constructed using the OpenCL API.

                                                                                                                                                                                                                                              ◆ platform() [3/5]

                                                                                                                                                                                                                                              cl::sycl::platform::platform ( const platform &  rhs)
                                                                                                                                                                                                                                              		default

                                                                                                                                                                                                                                              Copy Constructor.

                                                                                                                                                                                                                                              Constructs a platform object from another platform object.

                                                                                                                                                                                                                                              Parameters
                                                                                                                                                                                                                                              rhsThe platform object to copy

                                                                                                                                                                                                                                              ◆ platform() [4/5]

                                                                                                                                                                                                                                              cl::sycl::platform::platform ( const cl::sycl::device_selector &  deviceSelector)
                                                                                                                                                                                                                                              		explicit

                                                                                                                                                                                                                                              Constructs a platform from an existing device selector.

                                                                                                                                                                                                                                              Parameters
                                                                                                                                                                                                                                              deviceSelectorUser device selector

                                                                                                                                                                                                                                              ◆ platform() [5/5]

                                                                                                                                                                                                                                              cl::sycl::platform::platform ( detail::impl_constructor_tag  ,
                                                                                                                                                                                                                                              const detail::device_selector_wrapper &  deviceSelector 
                                                                                                                                                                                                                                              )
                                                                                                                                                                                                                                              		explicitprotected

                                                                                                                                                                                                                                              Constructs a SYCL platform object using a custom device selector callable.

                                                                                                                                                                                                                                              Parameters
                                                                                                                                                                                                                                              deviceSelectorCallable that can evaluate devices

                                                                                                                                                                                                                                              ◆ ~platform()

                                                                                                                                                                                                                                              cl::sycl::platform::~platform ( )
                                                                                                                                                                                                                                              		default

                                                                                                                                                                                                                                              Destroys the implementation object.

                                                                                                                                                                                                                                              Member Function Documentation

                                                                                                                                                                                                                                              ◆ get()

                                                                                                                                                                                                                                              cl_platform_id cl::sycl::platform::get ( ) const

                                                                                                                                                                                                                                              Returns the underlying cl_platform_id object.

                                                                                                                                                                                                                                              Returns
                                                                                                                                                                                                                                              The cl_platform_id object usable by the OpenCL API.

                                                                                                                                                                                                                                              ◆ get_devices()

                                                                                                                                                                                                                                              vector_class<device> cl::sycl::platform::get_devices ( info::device_type  deviceType = info::device_type::all) const

                                                                                                                                                                                                                                              Get a list of devices associated with the platform.

                                                                                                                                                                                                                                              Parameters
                                                                                                                                                                                                                                              deviceTypeThe type of devices to search for, set to info::device_type::all by default
                                                                                                                                                                                                                                              Returns
                                                                                                                                                                                                                                              A vector of device objects.

                                                                                                                                                                                                                                              ◆ get_impl()

                                                                                                                                                                                                                                              dplatform_shptr cl::sycl::platform::get_impl ( ) const

                                                                                                                                                                                                                                              ◆ get_info()

                                                                                                                                                                                                                                              template<info::platform param>
                                                                                                                                                                                                                                              info::param_traits<info::platform, param>::return_type cl::sycl::platform::get_info ( ) const
                                                                                                                                                                                                                                              		inline

                                                                                                                                                                                                                                              Get OpenCL information for the underlying cl_platform_id.

                                                                                                                                                                                                                                              Template Parameters
                                                                                                                                                                                                                                              paramThe info::platform descriptor parameter.
                                                                                                                                                                                                                                              Returns
                                                                                                                                                                                                                                              The retrieved information as the appropriate return type, derived via the param_traits struct, defined in param_traits.h.

                                                                                                                                                                                                                                              Definition at line 212 of file platform.h.

                                                                                                                                                                                                                                              ◆ get_no_retain()

                                                                                                                                                                                                                                              cl_platform_id cl::sycl::platform::get_no_retain ( ) const
                                                                                                                                                                                                                                              		noexcept

                                                                                                                                                                                                                                              Returns the underlying cl_platform_id object without checking if the system is host or device.

                                                                                                                                                                                                                                              Returns
                                                                                                                                                                                                                                              The cl_platform_id object usable by the OpenCL API.

                                                                                                                                                                                                                                              ◆ get_platforms()

                                                                                                                                                                                                                                              static vector_class<platform> cl::sycl::platform::get_platforms ( )
                                                                                                                                                                                                                                              		static

                                                                                                                                                                                                                                              Get a list of all available platforms.

                                                                                                                                                                                                                                              Returns
                                                                                                                                                                                                                                              A vector of platform objects. The returned vector will always contain a host platform.

                                                                                                                                                                                                                                              ◆ has_extension() [1/2]

                                                                                                                                                                                                                                              bool cl::sycl::platform::has_extension ( const char *  extension) const

                                                                                                                                                                                                                                              This function avoids using strings across the ABI.

                                                                                                                                                                                                                                              ◆ has_extension() [2/2]

                                                                                                                                                                                                                                              bool cl::sycl::platform::has_extension ( const string_class &  extension) const
                                                                                                                                                                                                                                              		inline

                                                                                                                                                                                                                                              Check whether a specific extension is supported on the platform.

                                                                                                                                                                                                                                              Parameters
                                                                                                                                                                                                                                              extensionA string specifying the extension to check for.
                                                                                                                                                                                                                                              Returns
                                                                                                                                                                                                                                              A boolean specifying whether the extension is supported by the platform.

                                                                                                                                                                                                                                              Definition at line 237 of file platform.h.

                                                                                                                                                                                                                                              ◆ has_impl()

                                                                                                                                                                                                                                              bool cl::sycl::platform::has_impl ( aspect_impl  asp) const
                                                                                                                                                                                                                                              		protected

                                                                                                                                                                                                                                              Returns true if all of the devices associated with the platform support the specified aspect.

                                                                                                                                                                                                                                              The aspect to be queried for.

                                                                                                                                                                                                                                              ◆ is_host()

                                                                                                                                                                                                                                              bool cl::sycl::platform::is_host ( ) const

                                                                                                                                                                                                                                              Specifies whether the platform is a host platform.

                                                                                                                                                                                                                                              Returns
                                                                                                                                                                                                                                              True if the platform is a host platform.

                                                                                                                                                                                                                                              ◆ operator=()

                                                                                                                                                                                                                                              platform& cl::sycl::platform::operator= ( const platform &  rhs)
                                                                                                                                                                                                                                              		default

                                                                                                                                                                                                                                              Assignment Operator.

                                                                                                                                                                                                                                              Completely assigns the contents of the platform to that of another.

                                                                                                                                                                                                                                              Parameters
                                                                                                                                                                                                                                              rhsThe platform object to copy

                                                                                                                                                                                                                                              Friends And Related Function Documentation

                                                                                                                                                                                                                                              ◆ operator!=

                                                                                                                                                                                                                                              bool operator!= ( const platform &  lhs,
                                                                                                                                                                                                                                              const platform &  rhs 
                                                                                                                                                                                                                                              )
                                                                                                                                                                                                                                              		friend

                                                                                                                                                                                                                                              Definition at line 177 of file platform.h.

                                                                                                                                                                                                                                              ◆ operator==

                                                                                                                                                                                                                                              bool operator== ( const platform &  lhs,
                                                                                                                                                                                                                                              const platform &  rhs 
                                                                                                                                                                                                                                              )
                                                                                                                                                                                                                                              		friend

                                                                                                                                                                                                                                              Checks for equality with another platform instance.

                                                                                                                                                                                                                                              Returns
                                                                                                                                                                                                                                              Boolean specifying whether the provided platform if this platform is equal to the the provided platform.

                                                                                                                                                                                                                                              Definition at line 173 of file platform.h.

                                                                                                                                                                                                                                              Member Data Documentation

                                                                                                                                                                                                                                              ◆ m_impl

                                                                                                                                                                                                                                              dplatform_shptr cl::sycl::platform::m_impl
                                                                                                                                                                                                                                              		protected

                                                                                                                                                                                                                                              Implementation object.

                                                                                                                                                                                                                                              Definition at line 292 of file platform.h.

                                                                                                                                                                                                                                              The documentation for this class was generated from the following file:

                                                                                                                                                                                                                                              Select a Product

                                                                                                                                                                                                                                              Please select a product

                                                                                                                                                                                                                                              oneAPI

                                                                                                                                                                                                                                              oneAPI is a cross-industry, open, standards-based unified programming model that delivers a common developer experience across accelerator architecture - for faster application performance, more productivity, and greater innovation.

                                                                                                                                                                                                                                              Dark Mode
                                                                                                                                                                                                                                              brightness_2

                                                                                                                                                                                                                                              Dark Mode

                                                                                                                                                                                                                                              Light text on a dark background.

                                                                                                                                                                                                                                              Light Mode
                                                                                                                                                                                                                                              lightbulb_outline

                                                                                                                                                                                                                                              Light Mode

                                                                                                                                                                                                                                              Dark text on a light background.

                                                                                                                                                                                                                                              public

                                                                                                                                                                                                                                              Also,

                                                                                                                                                                                                                                              part of our network

                                                                                                                                                                                                                                              search
                                                                                                                                                                                                                                              No results found, please try another search term.
                                                                                                                                                                                                                                              sync
                                                                                                                                                                                                                                              Searching, Please Wait...

                                                                                                                                                                                                                                              Please type to begin searching or try these:


                                                                                                                                                                                                                                              • oneapi nvidia
                                                                                                                                                                                                                                              • cl::sycl
                                                                                                                                                                                                                                              • 2.5.0
                                                                                                                                                                                                                                              • download oneapi amd
                                                                                                                                                                                                                                              • getting started guide
                                                                                                                                                                                                                                              • construction kit
                                                                                                                                                                                                                                              Tip: Press 'enter' key to select first result.
                                                                                                                                                                                                                                              There was a problem searching, please try again later.