ComputeWrappers.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/Detail/CoreExport.h"
 
namespace Zivid
{
    enum class ComputeBackend
    {
        cuda,
        opencl
    };

    struct OpenCLContextPtr
    {
        void *context = nullptr;
    };

    struct CUDAContextPtr
    {
        void *context = nullptr;
    };

    struct OpenCLCommandQueuePtr
    {
        void *commandQueue = nullptr; // cl_command_queue cast to void*
    };

    struct CUDAStreamPtr
    {
        void *stream = nullptr; // CUstream cast to void*
    };

    struct StreamOrQueue
    {
        CUDAStreamPtr stream;
        OpenCLCommandQueuePtr commandQueue;
 
        // NOLINTNEXTLINE(google-explicit-constructor,hicpp-explicit-conversions)
        StreamOrQueue(CUDAStreamPtr s)
            : stream{ s }
        {}
 
        // NOLINTNEXTLINE(google-explicit-constructor,hicpp-explicit-conversions)
        StreamOrQueue(OpenCLCommandQueuePtr q)
            : commandQueue{ q }
        {}
    };

    struct CUDADevicePointer
    {
        void *pointer = nullptr;
    };

    struct OpenCLMemPointer
    {
        void *memory = nullptr; // cl_mem cast to void*
    };

    ZIVID_CORE_EXPORT void synchronizeStream(StreamOrQueue streamOrQueue);
} // namespace Zivid