graphics.h

Go to the documentation of this file.

/*******************************************************
 * Copyright (c) 2014, 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 <af/defines.h>
#include <af/array.h>

typedef unsigned long long af_window;

typedef struct {
    int row;
    int col;
    const char* title;
    af_colormap cmap;
} af_cell;

#ifdef __cplusplus
namespace af
{

class AFAPI Window {
    private:
        af_window wnd;
        /* below attributes are used to track which
         * cell in the grid is being rendered currently */
        int _r;
        int _c;
        ColorMap _cmap;

        void initWindow(const int width, const int height, const char* const title);

        Window(const Window&);                 // Prevent copy-construction
        Window& operator=(const Window&);      // Prevent assignment

    public:
        Window();

        Window(const char* const title);

        Window(const int width, const int height, const char* const title="ArrayFire");

        Window(const af_window wnd);

        ~Window();

        // FIXME handle copying properly

        af_window get() const { return wnd; }

        void setPos(const unsigned x, const unsigned y);

        void setTitle(const char* const title);

#if AF_API_VERSION >= 31

        void setSize(const unsigned w, const unsigned h);
#endif

        void setColorMap(const ColorMap cmap);

        void image(const array& in, const char* title=NULL);

#if AF_API_VERSION >= 32

        void plot3(const array& in, const char* title=NULL);
#endif

        void plot(const array& X, const array& Y, const char* const title=NULL);

#if AF_API_VERSION >= 33

        void scatter(const array& X, const array& Y,
                     const af::markerType marker = AF_MARKER_POINT, const char* const title = NULL);
#endif

#if AF_API_VERSION >= 33

        void scatter3(const array& P, const af::markerType marker = AF_MARKER_POINT,
                      const char* const title = NULL);
#endif

        void hist(const array& X, const double minval, const double maxval, const char* const title=NULL);

#if AF_API_VERSION >= 32

        void surface(const array& S, const char* const title = NULL);
#endif

#if AF_API_VERSION >= 32

        void surface(const array& xVals, const array& yVals, const array& S, const char* const title = NULL);
#endif

        void grid(const int rows, const int cols);

        void show();

        bool close();

#if AF_API_VERSION >= 33

        void setVisibility(const bool isVisible);
#endif

        inline Window& operator()(const int r, const int c) {
            _r = r; _c = c;
            return *this;
        }
};

}
#endif

#ifdef __cplusplus
extern "C" {
#endif

AFAPI af_err af_create_window(af_window *out, const int width, const int height, const char* const title);

AFAPI af_err af_set_position(const af_window wind, const unsigned x, const unsigned y);

AFAPI af_err af_set_title(const af_window wind, const char* const title);

#if AF_API_VERSION >= 31

AFAPI af_err af_set_size(const af_window wind, const unsigned w, const unsigned h);
#endif

AFAPI af_err af_draw_image(const af_window wind, const af_array in, const af_cell* const props);

AFAPI af_err af_draw_plot(const af_window wind, const af_array X, const af_array Y, const af_cell* const props);

#if AF_API_VERSION >= 33

AFAPI af_err af_draw_scatter(const af_window wind, const af_array X, const af_array Y,
                             const af_marker_type marker, const af_cell* const props);
#endif

#if AF_API_VERSION >= 33

AFAPI af_err af_draw_scatter3(const af_window wind, const af_array P,
                              const af_marker_type marker, const af_cell* const props);
#endif

#if AF_API_VERSION >= 32

AFAPI af_err af_draw_plot3(const af_window wind, const af_array P, const af_cell* const props);
#endif

AFAPI af_err af_draw_hist(const af_window wind, const af_array X, const double minval, const double maxval, const af_cell* const props);

#if AF_API_VERSION >= 32

AFAPI af_err af_draw_surface(const af_window wind, const af_array xVals, const af_array yVals, const af_array S, const af_cell* const props);
#endif

AFAPI af_err af_grid(const af_window wind, const int rows, const int cols);

AFAPI af_err af_show(const af_window wind);

AFAPI af_err af_is_window_closed(bool *out, const af_window wind);

#if AF_API_VERSION >= 33

AFAPI af_err af_set_visibility(const af_window wind, const bool is_visible);
#endif

AFAPI af_err af_destroy_window(const af_window wind);

#ifdef __cplusplus
}

#endif