ComputeDevice.h

Go to the documentation of this file.

/*******************************************************************************
 * This file is part of the Zivid API
 *
 * Copyright 2015-2026 (C) Zivid AS
 * All rights reserved.
 *
 * Zivid Software License, v1.0
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 * 1. Redistributions of source code must retain the above copyright notice,
 * this list of conditions and the following disclaimer.
 *
 * 2. Redistributions in binary form must reproduce the above copyright notice,
 * this list of conditions and the following disclaimer in the documentation
 * and/or other materials provided with the distribution.
 *
 * 3. Neither the name of Zivid AS nor the names of its contributors may be used
 * to endorse or promote products derived from this software without specific
 * prior written permission.
 *
 * 4. This software, with or without modification, must not be used with any
 * other 3D camera than from Zivid AS.
 *
 * 5. Any software provided in binary form under this license must not be
 * reverse engineered, decompiled, modified and/or disassembled.
 *
 * THIS SOFTWARE IS PROVIDED BY ZIVID AS "AS IS" AND ANY EXPRESS OR IMPLIED
 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
 * MERCHANTABILITY, NONINFRINGEMENT, AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL ZIVID AS OR CONTRIBUTORS BE LIABLE FOR ANY
 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 * Contact: Zivid Customer Success Team <customersuccess@zivid.com>
 * Info:    http://www.zivid.com
 ******************************************************************************/
 
#pragma once
 
#include "Zivid/ComputeWrappers.h"
#include "Zivid/Detail/CoreExport.h"
#include "Zivid/DeviceArray.h"
 
#include <memory>
#include <string>
 
namespace Zivid
{
    class ComputeDeviceInterface;
    class Application;

    class ComputeDevice
    {
    private:
        std::shared_ptr<ComputeDeviceInterface> m_impl;
 
    public:
        ZIVID_CORE_EXPORT ComputeDevice();
#ifndef NO_DOC
        ZIVID_CORE_EXPORT explicit ComputeDevice(std::unique_ptr<ComputeDeviceInterface> &&impl);
#endif
        ZIVID_CORE_EXPORT ~ComputeDevice();

        ZIVID_CORE_EXPORT ComputeDevice(const ComputeDevice &other);

        ZIVID_CORE_EXPORT ComputeDevice &operator=(const ComputeDevice &other);

        ZIVID_CORE_EXPORT ComputeDevice(ComputeDevice &&other) noexcept;

        ZIVID_CORE_EXPORT ComputeDevice &operator=(ComputeDevice &&other) noexcept;

        ZIVID_CORE_EXPORT std::string model() const;

        ZIVID_CORE_EXPORT std::string vendor() const;

        ZIVID_CORE_EXPORT ComputeBackend backend() const;

        ZIVID_CORE_EXPORT void *nativeContext() const;

        ZIVID_CORE_EXPORT void *nativeStreamHandle() const;

        ZIVID_CORE_EXPORT StreamOrQueue sdkStreamOrQueue() const;

        template<typename Format, typename = std::enable_if_t<Detail::SupportedDeviceArrayViewFormat<Format>::value>>
        ZIVID_CORE_EXPORT DeviceArrayView<Format>
        createDeviceArrayView(CUDADevicePointer cudaPointer, size_t width, size_t height, CUDAStreamPtr stream) const;

        template<typename Format, typename = std::enable_if_t<Detail::SupportedDeviceArrayViewFormat<Format>::value>>
        ZIVID_CORE_EXPORT DeviceArrayView<Format> createDeviceArrayView(
            OpenCLMemPointer openCLBuffer,
            size_t width,
            size_t height,
            OpenCLCommandQueuePtr queue) const;

        ZIVID_CORE_EXPORT std::string cudaRuntimeLibraryName() const;

        ZIVID_CORE_EXPORT std::string toString() const;
 
#ifndef NO_DOC
        ZIVID_CORE_EXPORT ComputeDeviceInterface &getImpl();
        ZIVID_CORE_EXPORT const ComputeDeviceInterface &getImpl() const;
#endif
    };

    ZIVID_CORE_EXPORT std::ostream &operator<<(std::ostream &stream, const ComputeDevice &computeDevice);

    ZIVID_CORE_EXPORT std::string toString(ComputeBackend backend);

    ZIVID_CORE_EXPORT std::ostream &operator<<(std::ostream &stream, ComputeBackend backend);
 
#ifndef NO_DOC
#    define ZIVID_COMPUTE_DEVICE_EXTERN_CREATE_DEVICE_ARRAY_VIEW(Format)                                               \
        extern template ZIVID_CORE_EXPORT DeviceArrayView<Format>                                                      \
        ComputeDevice::createDeviceArrayView<Format, void>(CUDADevicePointer, size_t, size_t, CUDAStreamPtr) const;    \
        extern template ZIVID_CORE_EXPORT DeviceArrayView<Format> ComputeDevice::createDeviceArrayView<Format, void>(  \
            OpenCLMemPointer, size_t, size_t, OpenCLCommandQueuePtr) const
 
    ZIVID_COMPUTE_DEVICE_EXTERN_CREATE_DEVICE_ARRAY_VIEW(ColorRGBA);
    ZIVID_COMPUTE_DEVICE_EXTERN_CREATE_DEVICE_ARRAY_VIEW(ColorRGBA_SRGB);
    ZIVID_COMPUTE_DEVICE_EXTERN_CREATE_DEVICE_ARRAY_VIEW(ColorBGRA);
    ZIVID_COMPUTE_DEVICE_EXTERN_CREATE_DEVICE_ARRAY_VIEW(ColorBGRA_SRGB);
    ZIVID_COMPUTE_DEVICE_EXTERN_CREATE_DEVICE_ARRAY_VIEW(ColorRGBAf);
    ZIVID_COMPUTE_DEVICE_EXTERN_CREATE_DEVICE_ARRAY_VIEW(ColorRGB);
    ZIVID_COMPUTE_DEVICE_EXTERN_CREATE_DEVICE_ARRAY_VIEW(ColorRGB_SRGB);
    ZIVID_COMPUTE_DEVICE_EXTERN_CREATE_DEVICE_ARRAY_VIEW(ColorBGR);
    ZIVID_COMPUTE_DEVICE_EXTERN_CREATE_DEVICE_ARRAY_VIEW(ColorBGR_SRGB);
#    undef ZIVID_COMPUTE_DEVICE_EXTERN_CREATE_DEVICE_ARRAY_VIEW
#endif
} // namespace Zivid