surface.h

Go to the documentation of this file.

/*******************************************************
 * Copyright (c) 2015-2019, ArrayFire
 * All rights reserved.
 *
 * This file is distributed under 3-clause BSD license.
 * The complete license agreement can be obtained at:
 * http://arrayfire.com/licenses/BSD-3-Clause
 ********************************************************/

#pragma once

#include <fg/defines.h>

#ifdef __cplusplus
extern "C" {
#endif

FGAPI fg_err fg_create_surface(fg_surface *pSurface,
                            const unsigned pXPoints, const unsigned pYPoints,
                            const fg_dtype pType,
                            const fg_plot_type pPlotType,
                            const fg_marker_type pMarkerType);

FGAPI fg_err fg_destroy_surface(fg_surface pSurface);

FGAPI fg_err fg_set_surface_color(fg_surface pSurface,
                                  const float pRed, const float pGreen,
                                  const float pBlue, const float pAlpha);

FGAPI fg_err fg_set_surface_legend(fg_surface pSurface, const char* pLegend);

FGAPI fg_err fg_get_surface_vertex_buffer(unsigned* pOut, const fg_surface pSurface);

FGAPI fg_err fg_get_surface_color_buffer(unsigned* pOut, const fg_surface pSurface);

FGAPI fg_err fg_get_surface_alpha_buffer(unsigned* pOut, const fg_surface pSurface);

FGAPI fg_err fg_get_surface_vertex_buffer_size(unsigned* pOut, const fg_surface pSurface);

FGAPI fg_err fg_get_surface_color_buffer_size(unsigned* pOut, const fg_surface pSurface);

FGAPI fg_err fg_get_surface_alpha_buffer_size(unsigned* pOut, const fg_surface pSurface);

#ifdef __cplusplus
}
#endif

#ifdef __cplusplus

namespace forge
{

class Surface {
    private:
        fg_surface mValue;

    public:
        FGAPI Surface(const unsigned pNumXPoints, const unsigned pNumYPoints, const dtype pDataType,
                      const PlotType pPlotType=FG_PLOT_SURFACE, const MarkerType pMarkerType=FG_MARKER_NONE);

        FGAPI Surface(const Surface& pOther);

        FGAPI ~Surface();

        FGAPI void setColor(const forge::Color pColor);

        FGAPI void setColor(const float pRed, const float pGreen,
                            const float pBlue, const float pAlpha);

        FGAPI void setLegend(const char* pLegend);

        FGAPI unsigned vertices() const;

        FGAPI unsigned colors() const;

        FGAPI unsigned alphas() const;

        FGAPI unsigned verticesSize() const;

        FGAPI unsigned colorsSize() const;

        FGAPI unsigned alphasSize() const;


        FGAPI fg_surface get() const;
};

}

#endif