Frame2D.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/CameraInfo.h"
#include "Zivid/CameraState.h"
#include "Zivid/Color.h"
#include "Zivid/ComputeWrappers.h"
#include "Zivid/Detail/Pimpl.h"
#include "Zivid/DeviceArray.h"
#include "Zivid/FrameFileType.h"
#include "Zivid/FrameInfo.h"
#include "Zivid/Image.h"
#include "Zivid/Settings2D.h"
 
#include <string>
 
namespace Zivid
{
    class Frame2D
    {
        ZIVID_PIMPL_REFERENCE_SEMANTICS(Frame2D, ZIVID_CORE_EXPORT);
 
    public:
        ZIVID_CORE_EXPORT Frame2D();

        ZIVID_CORE_EXPORT Image<ColorRGBA> imageRGBA() const;

        ZIVID_CORE_EXPORT Image<ColorBGRA> imageBGRA() const;

        ZIVID_CORE_EXPORT Image<ColorRGBA_SRGB> imageSRGB() const;

        ZIVID_CORE_EXPORT Image<ColorRGBA_SRGB> imageRGBA_SRGB() const;

        ZIVID_CORE_EXPORT Image<ColorBGRA_SRGB> imageBGRA_SRGB() const;

        ZIVID_CORE_EXPORT Image<ColorRGB> imageRGB() const;

        ZIVID_CORE_EXPORT Image<ColorRGB_SRGB> imageRGB_SRGB() const;

        ZIVID_CORE_EXPORT Image<ColorBGR> imageBGR() const;

        ZIVID_CORE_EXPORT Image<ColorBGR_SRGB> imageBGR_SRGB() const;

        template<
            typename ColorFormat,
            typename = std::enable_if_t<Detail::SupportedImageDeviceArrayColorFormat<ColorFormat>::value>>
        ZIVID_CORE_EXPORT DeviceArray<ColorFormat> imageDeviceArray(StreamOrQueue streamOrQueue) const;

        template<
            typename ColorFormat,
            typename = std::enable_if_t<Detail::SupportedImageDeviceArrayColorFormat<ColorFormat>::value>>
        ZIVID_CORE_EXPORT void imageDeviceArray(
            DeviceArrayView<ColorFormat> destinationBuffer,
            StreamOrQueue streamOrQueue) const;

        ZIVID_CORE_EXPORT Settings2D settings() const;

        ZIVID_CORE_EXPORT CameraState state() const;

        ZIVID_CORE_EXPORT FrameInfo info() const;

        ZIVID_CORE_EXPORT CameraInfo cameraInfo() const;

        ZIVID_CORE_EXPORT std::string toString() const;

        ZIVID_CORE_EXPORT Frame2D clone() const;

        ZIVID_CORE_EXPORT void save(const std::string &fileName) const;

        ZIVID_CORE_EXPORT void load(const std::string &fileName);

        ZIVID_CORE_EXPORT explicit Frame2D(const std::string &fileName);
    };
 
#ifndef NO_DOC
    namespace Detail
    {
        ZIVID_CORE_EXPORT void waitUntilProcessingIsComplete(const Frame2D &frame);
    } // namespace Detail
#endif
 
#ifndef NO_DOC
#    define ZIVID_FRAME2D_EXTERN_IMAGE_DEVICE_ARRAY(Format)                                                            \
        extern template ZIVID_CORE_EXPORT DeviceArray<Format> Frame2D::imageDeviceArray<Format, void>(StreamOrQueue)   \
            const;                                                                                                     \
        extern template ZIVID_CORE_EXPORT void                                                                         \
        Frame2D::imageDeviceArray<Format, void>(DeviceArrayView<Format>, StreamOrQueue) const
 
    ZIVID_FRAME2D_EXTERN_IMAGE_DEVICE_ARRAY(ColorRGBA);
    ZIVID_FRAME2D_EXTERN_IMAGE_DEVICE_ARRAY(ColorRGBA_SRGB);
    ZIVID_FRAME2D_EXTERN_IMAGE_DEVICE_ARRAY(ColorBGRA);
    ZIVID_FRAME2D_EXTERN_IMAGE_DEVICE_ARRAY(ColorBGRA_SRGB);
    ZIVID_FRAME2D_EXTERN_IMAGE_DEVICE_ARRAY(ColorRGBAf);
    ZIVID_FRAME2D_EXTERN_IMAGE_DEVICE_ARRAY(ColorRGB);
    ZIVID_FRAME2D_EXTERN_IMAGE_DEVICE_ARRAY(ColorRGB_SRGB);
    ZIVID_FRAME2D_EXTERN_IMAGE_DEVICE_ARRAY(ColorBGR);
    ZIVID_FRAME2D_EXTERN_IMAGE_DEVICE_ARRAY(ColorBGR_SRGB);
#    undef ZIVID_FRAME2D_EXTERN_IMAGE_DEVICE_ARRAY
#endif
} // namespace Zivid