This is an automated email from the git hooks/post-receive script. It was generated because a ref change was pushed to the repository containing the project gfxprim.git. The branch, master has been updated via aaa7f50197c97d3b9b7f5d30cbe1f91c51f52384 (commit) via 5c61bb13e751a867d68d1443e20b80a992ae1e11 (commit) from fd437dffad5c449ae3dff083562b0db30ea1eb8e (commit) Those revisions listed above that are new to this repository have not appeared on any other notification email; so we list those revisions in full, below. - Log ----------------------------------------------------------------- http://repo.or.cz/w/gfxprim.git/commit/aaa7f50197c97d3b9b7f5d30cbe1f91c51f52... commit aaa7f50197c97d3b9b7f5d30cbe1f91c51f52384 Author: Cyril Hrubis <metan@ucw.cz> Date: Sat Nov 10 17:07:02 2012 +0100 doc: Add more examples and links. diff --git a/doc/backends.txt b/doc/backends.txt index 66728f7..a471652 100644 --- a/doc/backends.txt +++ b/doc/backends.txt @@ -10,6 +10,8 @@ controlling the drawing. So far there are three backends implemented, Linux mmaped frame-buffer, libSDL and X11 backend. +For example usage see backend link:example_backend.html[example]. + Initialization functions ~~~~~~~~~~~~~~~~~~~~~~~ diff --git a/doc/example_backend.txt b/doc/example_backend.txt new file mode 100644 index 0000000..ed13dea --- /dev/null +++ b/doc/example_backend.txt @@ -0,0 +1,7 @@ +Graphics Backend Example +------------------------ + +[source,c] +------------------------------------------------------------------ +include::../demos/c_simple/backend_example.c[] +------------------------------------------------------------------ diff --git a/doc/example_v4l2.txt b/doc/example_v4l2.txt new file mode 100644 index 0000000..2f1e389 --- /dev/null +++ b/doc/example_v4l2.txt @@ -0,0 +1,17 @@ +Graphics Backend Example +------------------------ + +Simple grabber that saves images taken from v4l2 device. + +[source,c] +------------------------------------------------------------------ +include::../demos/c_simple/v4l2_grab.c[] +------------------------------------------------------------------ + +More sophisticated example utilizing v4l2 device and +link:backends.html[backends]. + +[source,c] +------------------------------------------------------------------ +include::../demos/c_simple/v4l2_show.c[] +------------------------------------------------------------------ diff --git a/doc/grabbers.txt b/doc/grabbers.txt index 93af01b..a794847 100644 --- a/doc/grabbers.txt +++ b/doc/grabbers.txt @@ -8,6 +8,8 @@ There is currently V4L2 driver that implements a grabber. To link against grabbers use +-lGP_grabbers+ or better +`gfxprim-config --libs-grabbers`+ in your linker flags. +For example usage see grabber link:example_v4l2.html[examples]. + Grabber API ~~~~~~~~~~~ http://repo.or.cz/w/gfxprim.git/commit/5c61bb13e751a867d68d1443e20b80a992ae1... commit 5c61bb13e751a867d68d1443e20b80a992ae1e11 Author: Cyril Hrubis <metan@ucw.cz> Date: Sat Nov 10 16:55:08 2012 +0100 doc: Remove the all-in-one page API docs. diff --git a/doc/Makefile b/doc/Makefile index 19b89d2..4160ae0 100644 --- a/doc/Makefile +++ b/doc/Makefile @@ -1,6 +1,6 @@ SOURCES=general.txt context.txt loaders.txt filters.txt basic_types.txt drawing_api.txt backends.txt gamma.txt grabbers.txt - environment_variables.txt debug.txt core.txt + environment_variables.txt debug.txt core.txt api.txt EXAMPLE_SOURCES=$(wildcard example_*.txt) @@ -14,13 +14,7 @@ GENIMAGES=discrete_linear_1D_convolution_alg1 discrete_linear_1D_convolution_alg PAGES=$(subst .txt,.html,$(SOURCES)) PAGES+=$(subst .txt,.html,$(EXAMPLE_SOURCES)) -all: api.html examples.html $(PAGES) api_links.html - -# -# Create all in one API page -# -api.html: $(SOURCES) api.txt - asciidoc -a toc api.txt +all: examples.html $(PAGES) api.html # # Create page for each part of API description @@ -28,17 +22,9 @@ api.html: $(SOURCES) api.txt $(PAGES): %.html: %.txt asciidoc $< -api_links.html: api_links.txt - asciidoc $< - examples.html: examples.txt ../demos/c_simple/*.c ../demos/py_simple/*.py asciidoc -a toc examples.txt -api.pdf: api.txt - asciidoc -b docbook api.txt - xsltproc /usr/share/sgml/docbook/xsl-stylesheets/fo/docbook.xsl api.xml > api.fo - fop api.fo -pdf api.pdf - # # Clean up generated images # diff --git a/doc/README b/doc/README index 87e78a6..ae93336 100644 --- a/doc/README +++ b/doc/README @@ -3,7 +3,3 @@ This directory contains asciidoc documentation. The html pages are generated by typing 'make'. In order to do that asciidoc and source-highlight, latex and dvipng must be installed. - - -The pdf documentation could be generated by typing 'make api.pdf' for that fop -and xsltproc must be installed. diff --git a/doc/api.txt b/doc/api.txt index 899df1c..aff68ea 100644 --- a/doc/api.txt +++ b/doc/api.txt @@ -2,17 +2,56 @@ GFXprim API =========== Cyril Hrubis <metan@ucw.cz> -This documentation is also available link:api_links.html[divided into several -pages]. - -include::general.txt[] -include::basic_types.txt[] -include::environment_variables.txt[] -include::debug.txt[] -include::context.txt[] -include::gamma.txt[] -include::drawing_api.txt[] -include::filters.txt[] -include::loaders.txt[] -include::backends.txt[] -include::grabbers.txt[] +. link:basic_types.html[Basic library types] + + + Describes how colors and pixels are handled also describes progress callback + in great detail. + + +. link:core.html[Library Core overview] + + + Describes functions and macros in library core. + + +. link:debug.html[Debug Messages] + + + Interface to debug layer. + + +. link:context.html[Context] + + + The Context is description of in-memory bitmap including some meta-data + (size, pixel format, etc...). + + +. link:environment_variables.html[Environment Variables] + + + Description of environment variables that affects GFXprim behavior. + + +. link:gamma.html[Gamma correction] + + + The gama correction description and handling in GFXprim. + + +. link:drawing_api.html[Drawing primitives] + + + Drawing API for primitives such as lines, polygons and circles as well as + text drawing. + + +. link:filters.html[Context filters] + + + Context filters, basically all algorithms that takes an Context as an input + and returns Context as output. + + + Includes resampling, convolutions, low pass (blur) filters, dithering and + more. + + +. link:loaders.html[Context loaders] + + + Handles loading and saving images in standard formats. + + +. link:backends.html[Backends] + + + Backends API for drawing on the screen or into a window. + + +. link:grabbers.html[Grabbers] + + + Video grabbers interface such as V4L2. + + + +There is also a nice page with code link:examples.html[examples]. diff --git a/doc/api_links.txt b/doc/api_links.txt deleted file mode 100644 index 3aff6f9..0000000 --- a/doc/api_links.txt +++ /dev/null @@ -1,60 +0,0 @@ -GFXprim API -=========== -Cyril Hrubis <metan@ucw.cz> - -Also available in link:api.html[all in one page form]. - - -. link:basic_types.html[Basic library types] - + - Describes how colors and pixels are handled also describes progress callback - in great detail. - + -. link:core.html[Library Core overview] - + - Describes functions and macros in library core. - + -. link:debug.html[Debug Messages] - + - Interface to debug layer. - + -. link:context.html[Context] - + - The Context is description of in-memory bitmap including some meta-data - (size, pixel format, etc...). - + -. link:environment_variables.html[Environment Variables] - + - Description of environment variables that affects GFXprim behavior. - + -. link:gamma.html[Gamma correction] - + - The gama correction description and handling in GFXprim. - + -. link:drawing_api.html[Drawing primitives] - + - Drawing API for primitives such as lines, polygons and circles as well as - text drawing. - + -. link:filters.html[Context filters] - + - Context filters, basically all algorithms that takes an Context as an input - and returns Context as output. - + - Includes resampling, convolutions, low pass (blur) filters, dithering and - more. - + -. link:loaders.html[Context loaders] - + - Handles loading and saving images in standard formats. - + -. link:backends.html[Backends] - + - Backends API for drawing on the screen or into a window. - + -. link:grabbers.html[Grabbers] - + - Video grabbers interface such as V4L2. - + - -There is also a nice page with code link:examples.html[examples]. ----------------------------------------------------------------------- Summary of changes: doc/Makefile | 18 +----- doc/README | 4 - doc/api.txt | 67 +++++++++++++++---- doc/api_links.txt | 60 ----------------- doc/backends.txt | 2 + ...loader_registration.txt => example_backend.txt} | 6 +- doc/example_v4l2.txt | 17 +++++ doc/grabbers.txt | 2 + 8 files changed, 79 insertions(+), 97 deletions(-) delete mode 100644 doc/api_links.txt copy doc/{example_loader_registration.txt => example_backend.txt} (55%) create mode 100644 doc/example_v4l2.txt repo.or.cz automatic notification. Contact project admin jiri.bluebear.dluhos@gmail.com if you want to unsubscribe, or site admin admin@repo.or.cz if you receive no reply. -- gfxprim.git ("A simple 2D graphics library with emphasis on correctness and well-defined operation.")