libigl/include/igl/opengl/stb/render_to_file.h

// This file is part of libigl, a simple c++ geometry processing library.
// 
// Copyright (C) 2013 Alec Jacobson <[email protected]>
// 
// This Source Code Form is subject to the terms of the Mozilla Public License 
// v. 2.0. If a copy of the MPL was not distributed with this file, You can 
// obtain one at http://mozilla.org/MPL/2.0/.
#ifndef IGL_OPENGL_STB_RENDER_TO_PNG_H
#define IGL_OPENGL_STB_RENDER_TO_PNG_H
#include "../../igl_inline.h"

#include <string>
namespace igl
{
  namespace opengl
  {
    namespace stb
    {
      /// Render current open GL image to an image file
      ///
      /// @param[in] filename  path to output file
      /// @param[in] width  width of scene and resulting image
      /// @param[in] height height of scene and resulting image
      /// @param[in] alpha  whether to include alpha channel
      /// @return true only if no errors occurred
      ///
      /// \see igl::stb::write_image, render_to_file_async
      IGL_INLINE bool render_to_file(
        const std::string filename,
        const int width,
        const int height,
        const bool alpha = true);
    }
  }
}

#ifndef IGL_STATIC_LIBRARY
#  include "render_to_file.cpp"
#endif

#endif