Edgaru089/SFML
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Synchronized with trunk

Browse Source 
git-svn-id: https://sfml.svn.sourceforge.net/svnroot/sfml/branches/sfml2@1171 4e206d99-4929-0410-ac5d-dfc041789085
This commit is contained in:
LaurentGom 2009-07-12 09:59:21 +00:00
commit 9c959777d3
10 changed files with 1637 additions and 353 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

239
CSFML/Doxyfile
View File

@ -1,239 +0,0 @@
# Doxyfile 1.5.2
#---------------------------------------------------------------------------
# Project related configuration options
#---------------------------------------------------------------------------
DOXYFILE_ENCODING = UTF-8
PROJECT_NAME = SFML
PROJECT_NUMBER =
OUTPUT_DIRECTORY = doc
CREATE_SUBDIRS = NO
OUTPUT_LANGUAGE = English
BRIEF_MEMBER_DESC = YES
REPEAT_BRIEF = YES
ABBREVIATE_BRIEF = "The $name class" \
"The $name widget" \
"The $name file" \
is \
provides \
specifies \
contains \
represents \
a \
an \
the
ALWAYS_DETAILED_SEC = YES
INLINE_INHERITED_MEMB = YES
FULL_PATH_NAMES = NO
STRIP_FROM_PATH =
STRIP_FROM_INC_PATH =
SHORT_NAMES = NO
JAVADOC_AUTOBRIEF = YES
MULTILINE_CPP_IS_BRIEF = NO
DETAILS_AT_TOP = NO
INHERIT_DOCS = YES
SEPARATE_MEMBER_PAGES = NO
TAB_SIZE = 4
ALIASES =
OPTIMIZE_OUTPUT_FOR_C = YES
OPTIMIZE_OUTPUT_JAVA = NO
BUILTIN_STL_SUPPORT = NO
CPP_CLI_SUPPORT = NO
DISTRIBUTE_GROUP_DOC = NO
SUBGROUPING = YES
#---------------------------------------------------------------------------
# Build related configuration options
#---------------------------------------------------------------------------
EXTRACT_ALL = YES
EXTRACT_PRIVATE = NO
EXTRACT_STATIC = NO
EXTRACT_LOCAL_CLASSES = NO
EXTRACT_LOCAL_METHODS = NO
HIDE_UNDOC_MEMBERS = NO
HIDE_UNDOC_CLASSES = NO
HIDE_FRIEND_COMPOUNDS = NO
HIDE_IN_BODY_DOCS = NO
INTERNAL_DOCS = NO
CASE_SENSE_NAMES = YES
HIDE_SCOPE_NAMES = NO
SHOW_INCLUDE_FILES = YES
INLINE_INFO = YES
SORT_MEMBER_DOCS = YES
SORT_BRIEF_DOCS = NO
SORT_BY_SCOPE_NAME = NO
GENERATE_TODOLIST = YES
GENERATE_TESTLIST = YES
GENERATE_BUGLIST = YES
GENERATE_DEPRECATEDLIST= YES
ENABLED_SECTIONS =
MAX_INITIALIZER_LINES = 30
SHOW_USED_FILES = YES
SHOW_DIRECTORIES = NO
FILE_VERSION_FILTER =
#---------------------------------------------------------------------------
# configuration options related to warning and progress messages
#---------------------------------------------------------------------------
QUIET = NO
WARNINGS = YES
WARN_IF_UNDOCUMENTED = YES
WARN_IF_DOC_ERROR = YES
WARN_NO_PARAMDOC = YES
WARN_FORMAT = "$file:$line: $text"
WARN_LOGFILE =
#---------------------------------------------------------------------------
# configuration options related to the input files
#---------------------------------------------------------------------------
INPUT = include/SFML/ \
Doxygen.hpp
INPUT_ENCODING = UTF-8
FILE_PATTERNS = *.h \
*.hpp
RECURSIVE = YES
EXCLUDE =
EXCLUDE_SYMLINKS = NO
EXCLUDE_PATTERNS = .svn
EXCLUDE_SYMBOLS =
EXAMPLE_PATH =
EXAMPLE_PATTERNS = *
EXAMPLE_RECURSIVE = NO
IMAGE_PATH =
INPUT_FILTER =
FILTER_PATTERNS =
FILTER_SOURCE_FILES = NO
#---------------------------------------------------------------------------
# configuration options related to source browsing
#---------------------------------------------------------------------------
SOURCE_BROWSER = YES
INLINE_SOURCES = NO
STRIP_CODE_COMMENTS = YES
REFERENCED_BY_RELATION = NO
REFERENCES_RELATION = NO
REFERENCES_LINK_SOURCE = NO
USE_HTAGS = NO
VERBATIM_HEADERS = YES
#---------------------------------------------------------------------------
# configuration options related to the alphabetical class index
#---------------------------------------------------------------------------
ALPHABETICAL_INDEX = YES
COLS_IN_ALPHA_INDEX = 5
IGNORE_PREFIX =
#---------------------------------------------------------------------------
# configuration options related to the HTML output
#---------------------------------------------------------------------------
GENERATE_HTML = YES
HTML_OUTPUT = html
HTML_FILE_EXTENSION = .htm
HTML_HEADER = ../header.htm
HTML_FOOTER = ../footer.htm
HTML_STYLESHEET = ../doxygen.css
HTML_ALIGN_MEMBERS = YES
GENERATE_HTMLHELP = YES
CHM_FILE = ../SFML.chm
HHC_LOCATION = "C:/Program Files/HTML Help Workshop/hhc.exe"
GENERATE_CHI = NO
BINARY_TOC = NO
TOC_EXPAND = NO
DISABLE_INDEX = NO
ENUM_VALUES_PER_LINE = 1
GENERATE_TREEVIEW = NO
TREEVIEW_WIDTH = 250
#---------------------------------------------------------------------------
# configuration options related to the LaTeX output
#---------------------------------------------------------------------------
GENERATE_LATEX = NO
LATEX_OUTPUT = latex
LATEX_CMD_NAME = latex
MAKEINDEX_CMD_NAME = makeindex
COMPACT_LATEX = NO
PAPER_TYPE = a4wide
EXTRA_PACKAGES =
LATEX_HEADER =
PDF_HYPERLINKS = NO
USE_PDFLATEX = NO
LATEX_BATCHMODE = NO
LATEX_HIDE_INDICES = NO
#---------------------------------------------------------------------------
# configuration options related to the RTF output
#---------------------------------------------------------------------------
GENERATE_RTF = NO
RTF_OUTPUT = rtf
COMPACT_RTF = NO
RTF_HYPERLINKS = NO
RTF_STYLESHEET_FILE =
RTF_EXTENSIONS_FILE =
#---------------------------------------------------------------------------
# configuration options related to the man page output
#---------------------------------------------------------------------------
GENERATE_MAN = NO
MAN_OUTPUT = man
MAN_EXTENSION = .3
MAN_LINKS = NO
#---------------------------------------------------------------------------
# configuration options related to the XML output
#---------------------------------------------------------------------------
GENERATE_XML = NO
XML_OUTPUT = xml
XML_SCHEMA =
XML_DTD =
XML_PROGRAMLISTING = YES
#---------------------------------------------------------------------------
# configuration options for the AutoGen Definitions output
#---------------------------------------------------------------------------
GENERATE_AUTOGEN_DEF = NO
#---------------------------------------------------------------------------
# configuration options related to the Perl module output
#---------------------------------------------------------------------------
GENERATE_PERLMOD = NO
PERLMOD_LATEX = NO
PERLMOD_PRETTY = YES
PERLMOD_MAKEVAR_PREFIX =
#---------------------------------------------------------------------------
# Configuration options related to the preprocessor
#---------------------------------------------------------------------------
ENABLE_PREPROCESSING = YES
MACRO_EXPANSION = NO
EXPAND_ONLY_PREDEF = NO
SEARCH_INCLUDES = YES
INCLUDE_PATH =
INCLUDE_FILE_PATTERNS =
PREDEFINED =
EXPAND_AS_DEFINED =
SKIP_FUNCTION_MACROS = YES
#---------------------------------------------------------------------------
# Configuration::additions related to external references
#---------------------------------------------------------------------------
TAGFILES =
GENERATE_TAGFILE =
ALLEXTERNALS = NO
EXTERNAL_GROUPS = YES
PERL_PATH = /usr/bin/perl
#---------------------------------------------------------------------------
# Configuration options related to the dot tool
#---------------------------------------------------------------------------
CLASS_DIAGRAMS = YES
MSCGEN_PATH = D:/Programmes/mscgen
HIDE_UNDOC_RELATIONS = YES
HAVE_DOT = NO
CLASS_GRAPH = YES
COLLABORATION_GRAPH = YES
GROUP_GRAPHS = YES
UML_LOOK = NO
TEMPLATE_RELATIONS = NO
INCLUDE_GRAPH = YES
INCLUDED_BY_GRAPH = YES
CALL_GRAPH = NO
CALLER_GRAPH = NO
GRAPHICAL_HIERARCHY = YES
DIRECTORY_GRAPH = YES
DOT_IMAGE_FORMAT = png
DOT_PATH =
DOTFILE_DIRS =
DOT_GRAPH_MAX_NODES = 50
DOT_TRANSPARENT = NO
DOT_MULTI_TARGETS = NO
GENERATE_LEGEND = YES
DOT_CLEANUP = YES
#---------------------------------------------------------------------------
# Configuration::additions related to the search engine
#---------------------------------------------------------------------------
SEARCHENGINE = NO

95
CSFML/Doxygen.hpp
View File

@ -1,95 +0,0 @@
////////////////////////////////////////////////////////////
/// \mainpage
///
/// \section welcome Welcome
/// Welcome to the official SFML documentation for C. Here you will find a detailed
/// view of all the SFML <a href="./globals_func.htm">functions</a>, as well as source
/// <a href="./files.htm">files</a>. <br/>
/// If you are looking for tutorials, you can visit the official website
/// at <a href="http://www.sfml-dev.org/tutorials/">www.sfml-dev.org</a>.
///
/// \section example Short example
/// Here is a short example, to show you how simple it is to use SFML in C :
///
/// \code
///
/// #include <SFML/Audio.h>
/// #include <SFML/Graphics.h>
///
/// int main()
/// {
/// sfWindowSettings Settings = {24, 8, 0};
/// sfVideoMode Mode = {800, 600, 32};
/// sfRenderWindow* App;
/// sfImage* Image;
/// sfSprite* Sprite;
/// sfFont* Font;
/// sfString* Text;
/// sfMusic* Music;
/// sfEvent Event;
///
/// /* Create the main window */
/// App = sfRenderWindow_Create(Mode, "SFML window", sfResize | sfClose, Settings);
/// if (!App)
/// return EXIT_FAILURE;
///
/// /* Load a sprite to display */
/// Image = sfImage_CreateFromFile("cute_image.jpg");
/// if (!Image)
/// return EXIT_FAILURE;
/// Sprite = sfSprite_Create();
/// sfSprite_SetImage(Sprite, Image);
///
/// /* Create a graphical string to display */
/// Font = sfFont_CreateFromFile("arial.ttf", 50, NULL);
/// if (!Font)
/// return EXIT_FAILURE;
/// Text = sfString_Create();
/// sfString_SetText(Text, "Hello SFML");
/// sfString_SetFont(Text, Font);
/// sfString_SetSize(Text, 50);
///
/// /* Load a music to play */
/// Music = sfMusic_CreateFromFile("nice_music.ogg");
/// if (!Music)
/// return EXIT_FAILURE;
///
/// /* Play the music */
/// sfMusic_Play(Music);
///
/// /* Start the game loop */
/// while (sfRenderWindow_IsOpened(App))
/// {
/// /* Process events */
/// while (sfRenderWindow_GetEvent(App, &Event))
/// {
/// /* Close window : exit */
/// if (Event.Type == sfEvtClosed)
/// sfRenderWindow_Close(App);
/// }
///
/// /* Clear the screen */
/// sfRenderWindow_Clear(App, sfBlack);
///
/// /* Draw the sprite */
/// sfRenderWindow_DrawSprite(App, Sprite);
///
/// /* Draw the string */
/// sfRenderWindow_DrawString(App, Text);
///
/// /* Update the window */
/// sfRenderWindow_Display(App);
/// }
///
/// /* Cleanup resources */
/// sfMusic_Destroy(Music);
/// sfString_Destroy(Text);
/// sfFont_Destroy(Font);
/// sfSprite_Destroy(Sprite);
/// sfImage_Destroy(Image);
/// sfRenderWindow_Destroy(App);
///
/// return EXIT_SUCCESS;
/// }
/// \endcode
////////////////////////////////////////////////////////////

10
CSFML/doc/SFML.htm Normal file
View File

@ -0,0 +1,10 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<title>SFML reference documentation</title>
<meta http-equiv="content-type" content="text/html; charset=ISO-8859-1" />
<meta http-equiv="refresh" content="0; url=./html/index.htm" />
<meta name="robots" content="noindex,follow" />
</head>
</html>

1513
CSFML/doc/build/Doxyfile vendored Normal file
View File

File diff suppressed because it is too large Load Diff

95
CSFML/doc/build/Doxygen.hpp vendored Normal file
View File

@ -0,0 +1,95 @@
////////////////////////////////////////////////////////////
/// \mainpage
///
/// \section welcome Welcome
/// Welcome to the official SFML documentation for C. Here you will find a detailed
/// view of all the SFML <a href="./globals_func.htm">functions</a>, as well as source
/// <a href="./files.htm">files</a>. <br/>
/// If you are looking for tutorials, you can visit the official website
/// at <a href="http://www.sfml-dev.org/tutorials/">www.sfml-dev.org</a>.
///
/// \section example Short example
/// Here is a short example, to show you how simple it is to use SFML in C :
///
/// \code
///
/// #include <SFML/Audio.h>
/// #include <SFML/Graphics.h>
///
/// int main()
/// {
/// sfWindowSettings settings = {24, 8, 0};
/// sfVideoMode mode = {800, 600, 32};
/// sfRenderWindow* window;
/// sfImage* image;
/// sfSprite* sprite;
/// sfFont* font;
/// sfString* text;
/// sfMusic* music;
/// sfEvent event;
///
/// /* Create the main window */
/// window = sfRenderWindow_Create(mode, "SFML window", sfResize | sfClose, settings);
/// if (!window)
/// return EXIT_FAILURE;
///
/// /* Load a sprite to display */
/// image = sfImage_CreateFromFile("cute_image.jpg");
/// if (!image)
/// return EXIT_FAILURE;
/// sprite = sfSprite_Create();
/// sfSprite_SetImage(sprite, image);
///
/// /* Create a graphical string to display */
/// font = sfFont_CreateFromFile("arial.ttf", 50, NULL);
/// if (!font)
/// return EXIT_FAILURE;
/// text = sfString_Create();
/// sfString_SetText(text, "Hello SFML");
/// sfString_SetFont(text, font);
/// sfString_SetSize(text, 50);
///
/// /* Load a music to play */
/// music = sfMusic_CreateFromFile("nice_music.ogg");
/// if (!music)
/// return EXIT_FAILURE;
///
/// /* Play the music */
/// sfMusic_Play(music);
///
/// /* Start the game loop */
/// while (sfRenderWindow_IsOpened(window))
/// {
/// /* Process events */
/// while (sfRenderWindow_GetEvent(window, &event))
/// {
/// /* Close window : exit */
/// if (event.Type == sfEvtClosed)
/// sfRenderWindow_Close(window);
/// }
///
/// /* Clear the screen */
/// sfRenderWindow_Clear(window, sfBlack);
///
/// /* Draw the sprite */
/// sfRenderWindow_DrawSprite(window, sprite);
///
/// /* Draw the string */
/// sfRenderWindow_DrawString(window, text);
///
/// /* Update the window */
/// sfRenderWindow_Display(window);
/// }
///
/// /* Cleanup resources */
/// sfMusic_Destroy(music);
/// sfString_Destroy(text);
/// sfFont_Destroy(font);
/// sfSprite_Destroy(sprite);
/// sfImage_Destroy(image);
/// sfRenderWindow_Destroy(window);
///
/// return EXIT_SUCCESS;
/// }
/// \endcode
////////////////////////////////////////////////////////////

0
CSFML/footer.htm → CSFML/doc/build/footer.htm vendored
View File

0
CSFML/header.htm → CSFML/doc/build/header.htm vendored
View File

BIN
CSFML/doc/html/logo-bg.jpg Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 22 KiB

BIN
CSFML/doc/html/logo.jpg Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 114 KiB

38
doc/build/Doxygen.hpp vendored
View File

@ -19,51 +19,51 @@
/// int main()
/// {
/// // Create the main window
/// sf::RenderWindow App(sf::VideoMode(800, 600), "SFML window");
/// sf::RenderWindow window(sf::VideoMode(800, 600), "SFML window");
///
/// // Load a sprite to display
/// sf::Image Image;
/// if (!Image.LoadFromFile("cute_image.jpg"))
/// sf::Image image;
/// if (!image.LoadFromFile("cute_image.jpg"))
/// return EXIT_FAILURE;
/// sf::Sprite Sprite(Image);
/// sf::Sprite sprite(image);
///
/// // Create a graphical string to display
/// sf::Font Arial;
/// if (!Arial.LoadFromFile("arial.ttf"))
/// sf::Font font;
/// if (!font.LoadFromFile("arial.ttf"))
/// return EXIT_FAILURE;
/// sf::String Text("Hello SFML", Arial, 50);
/// sf::String text("Hello SFML", font, 50);
///
/// // Load a music to play
/// sf::Music Music;
/// if (!Music.OpenFromFile("nice_music.ogg"))
/// sf::Music music;
/// if (!music.OpenFromFile("nice_music.ogg"))
/// return EXIT_FAILURE;
///
/// // Play the music
/// Music.Play();
/// music.Play();
///
/// // Start the game loop
/// while (App.IsOpened())
/// while (window.IsOpened())
/// {
/// // Process events
/// sf::Event Event;
/// while (App.GetEvent(Event))
/// sf::Event event;
/// while (window.GetEvent(event))
/// {
/// // Close window : exit
/// if (Event.Type == sf::Event::Closed)
/// App.Close();
/// if (event.Type == sf::Event::Closed)
/// window.Close();
/// }
///
/// // Clear screen
/// App.Clear();
/// window.Clear();
///
/// // Draw the sprite
/// App.Draw(Sprite);
/// window.Draw(sprite);
///
/// // Draw the string
/// App.Draw(Text);
/// window.Draw(text);
///
/// // Update the window
/// App.Display();
/// window.Display();
/// }
///
/// return EXIT_SUCCESS;