git.sesse.net Git - casparcg/blob - dependencies64/sfml/include/SFML/System/Err.hpp

   1 ////////////////////////////////////////////////////////////
   2 //
   3 // SFML - Simple and Fast Multimedia Library
   4 // Copyright (C) 2007-2014 Laurent Gomila (laurent.gom@gmail.com)
   5 //
   6 // This software is provided 'as-is', without any express or implied warranty.
   7 // In no event will the authors be held liable for any damages arising from the use of this software.
   8 //
   9 // Permission is granted to anyone to use this software for any purpose,
  10 // including commercial applications, and to alter it and redistribute it freely,
  11 // subject to the following restrictions:
  12 //
  13 // 1. The origin of this software must not be misrepresented;
  14 //    you must not claim that you wrote the original software.
  15 //    If you use this software in a product, an acknowledgment
  16 //    in the product documentation would be appreciated but is not required.
  17 //
  18 // 2. Altered source versions must be plainly marked as such,
  19 //    and must not be misrepresented as being the original software.
  20 //
  21 // 3. This notice may not be removed or altered from any source distribution.
  22 //
  23 ////////////////////////////////////////////////////////////
  24
  25 #ifndef SFML_ERR_HPP
  26 #define SFML_ERR_HPP
  27
  28 ////////////////////////////////////////////////////////////
  29 // Headers
  30 ////////////////////////////////////////////////////////////
  31 #include <SFML/System/Export.hpp>
  32 #include <ostream>
  33
  34
  35 namespace sf
  36 {
  37 ////////////////////////////////////////////////////////////
  38 /// \brief Standard stream used by SFML to output warnings and errors
  39 ///
  40 ////////////////////////////////////////////////////////////
  41 SFML_SYSTEM_API std::ostream& err();
  42
  43 } // namespace sf
  44
  45
  46 #endif // SFML_ERR_HPP
  47
  48
  49 ////////////////////////////////////////////////////////////
  50 /// \fn sf::err
  51 /// \ingroup system
  52 ///
  53 /// By default, sf::err() outputs to the same location as std::cerr,
  54 /// (-> the stderr descriptor) which is the console if there's
  55 /// one available.
  56 ///
  57 /// It is a standard std::ostream instance, so it supports all the
  58 /// insertion operations defined by the STL
  59 /// (operator <<, manipulators, etc.).
  60 ///
  61 /// sf::err() can be redirected to write to another output, independently
  62 /// of std::cerr, by using the rdbuf() function provided by the
  63 /// std::ostream class.
  64 ///
  65 /// Example:
  66 /// \code
  67 /// // Redirect to a file
  68 /// std::ofstream file("sfml-log.txt");
  69 /// std::streambuf* previous = sf::err().rdbuf(file.rdbuf());
  70 ///
  71 /// // Redirect to nothing
  72 /// sf::err().rdbuf(NULL);
  73 ///
  74 /// // Restore the original output
  75 /// sf::err().rdbuf(previous);
  76 /// \endcode
  77 ///
  78 /// \return Reference to std::ostream representing the SFML error stream
  79 ///
  80 ////////////////////////////////////////////////////////////