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::exception Class Reference

                                                                                                                                                                                                                                              SYCL exception class, defined Section 3.2 of the specification, for general SYCL error. More...

                                                                                                                                                                                                                                              #include <error.h>

                                                                                                                                                                                                                                              Inheritance diagram for cl::sycl::exception:

                                                                                                                                                                                                                                              Public Member Functions

                                                                                                                                                                                                                                              const char * what () const noexcept
                                                                                                                                                                                                                                               Overload of std::runtime_error::what() which returns the message associated with the error. More...
                                                                                                                                                                                                                                               
                                                                                                                                                                                                                                              bool has_context () const noexcept
                                                                                                                                                                                                                                               Reports whether the exception has a context associated with it. More...
                                                                                                                                                                                                                                               
                                                                                                                                                                                                                                              cl::sycl::context get_context () const
                                                                                                                                                                                                                                               Returns the SYCL context that is associated with this SYCL exception. More...
                                                                                                                                                                                                                                               
                                                                                                                                                                                                                                              cl_int get_cl_code () const
                                                                                                                                                                                                                                               Returns the OpenCL error code. More...
                                                                                                                                                                                                                                               

                                                                                                                                                                                                                                              Protected Member Functions

                                                                                                                                                                                                                                               exception (detail::impl_constructor_tag, std::error_code errorCode, const char *whatArg)
                                                                                                                                                                                                                                               
                                                                                                                                                                                                                                               exception (detail::impl_constructor_tag, context ctx, std::error_code errorCode, const char *whatArg)
                                                                                                                                                                                                                                               
                                                                                                                                                                                                                                              const std::error_code & get_log_errc () const noexcept
                                                                                                                                                                                                                                               Returns the error_code from inside the member sycl_log to avoid leaking the full log definition. More...
                                                                                                                                                                                                                                               

                                                                                                                                                                                                                                              Detailed Description

                                                                                                                                                                                                                                              SYCL exception class, defined Section 3.2 of the specification, for general SYCL error.

                                                                                                                                                                                                                                              This implementation adds extra methods to those defined in the specification to provide additional information to the user.

                                                                                                                                                                                                                                              Definition at line 182 of file error.h.

                                                                                                                                                                                                                                              Constructor & Destructor Documentation

                                                                                                                                                                                                                                              ◆ exception() [1/2]

                                                                                                                                                                                                                                              cl::sycl::exception::exception ( detail::impl_constructor_tag  ,
                                                                                                                                                                                                                                              std::error_code  errorCode,
                                                                                                                                                                                                                                              const char *  whatArg 
                                                                                                                                                                                                                                              )
                                                                                                                                                                                                                                              		protected

                                                                                                                                                                                                                                              ◆ exception() [2/2]

                                                                                                                                                                                                                                              cl::sycl::exception::exception ( detail::impl_constructor_tag  ,
                                                                                                                                                                                                                                              context  ctx,
                                                                                                                                                                                                                                              std::error_code  errorCode,
                                                                                                                                                                                                                                              const char *  whatArg 
                                                                                                                                                                                                                                              )
                                                                                                                                                                                                                                              		protected

                                                                                                                                                                                                                                              Member Function Documentation

                                                                                                                                                                                                                                              ◆ get_cl_code()

                                                                                                                                                                                                                                              cl_int cl::sycl::exception::get_cl_code ( ) const

                                                                                                                                                                                                                                              Returns the OpenCL error code.

                                                                                                                                                                                                                                              Value extracted directly from the OpenCL header.

                                                                                                                                                                                                                                              Returns
                                                                                                                                                                                                                                              int OpenCL error code

                                                                                                                                                                                                                                              ◆ get_context()

                                                                                                                                                                                                                                              cl::sycl::context cl::sycl::exception::get_context ( ) const

                                                                                                                                                                                                                                              Returns the SYCL context that is associated with this SYCL exception.

                                                                                                                                                                                                                                              If no context is associated with this exception, it throws a new exception.

                                                                                                                                                                                                                                              Returns
                                                                                                                                                                                                                                              Context that is associated with this exception

                                                                                                                                                                                                                                              ◆ get_log_errc()

                                                                                                                                                                                                                                              const std::error_code& cl::sycl::exception::get_log_errc ( ) const
                                                                                                                                                                                                                                              		protectednoexcept

                                                                                                                                                                                                                                              Returns the error_code from inside the member sycl_log to avoid leaking the full log definition.

                                                                                                                                                                                                                                              Returns
                                                                                                                                                                                                                                              const ref to an std::error_code

                                                                                                                                                                                                                                              ◆ has_context()

                                                                                                                                                                                                                                              bool cl::sycl::exception::has_context ( ) const
                                                                                                                                                                                                                                              		noexcept

                                                                                                                                                                                                                                              Reports whether the exception has a context associated with it.

                                                                                                                                                                                                                                              Returns
                                                                                                                                                                                                                                              True if a context is associated with this exception

                                                                                                                                                                                                                                              ◆ what()

                                                                                                                                                                                                                                              const char* cl::sycl::exception::what ( ) const
                                                                                                                                                                                                                                              		noexcept

                                                                                                                                                                                                                                              Overload of std::runtime_error::what() which returns the message associated with the error.

                                                                                                                                                                                                                                              Returns
                                                                                                                                                                                                                                              The message associated with the error.
                                                                                                                                                                                                                                              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.