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 00460e85d190a282d97009977cecdc5a6b9c101a (commit) via 14fa043cbe2545c0970092ffaef9ead7ef29fe02 (commit) from b7b1aa5e558261c0787fad6e924969625cd465ce (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/00460e85d190a282d97009977cecdc5a6b9c1...
commit 00460e85d190a282d97009977cecdc5a6b9c101a Author: Cyril Hrubis metan@ucw.cz Date: Fri Jul 6 15:51:15 2012 +0200
doc: Generate page per topic docs too.
diff --git a/doc/Makefile b/doc/Makefile index 7eb952d..9bc6c52 100644 --- a/doc/Makefile +++ b/doc/Makefile @@ -1,10 +1,26 @@ -all: api.html examples.html +SOURCES=general.txt context.txt loaders.txt filters.txt basic_types.txt + drawing_api.txt backends.txt gamma.txt grabbers.txt
-api.html: general.txt api.txt context.txt loaders.txt filters.txt - basic_types.txt drawing_api.txt backends.txt gamma.txt - grabbers.txt +PAGES=$(subst .txt,.html,$(SOURCES)) + + +all: api.html examples.html $(PAGES) api_links.html + +# +# Create all in one API page +# +api.html: $(SOURCES) asciidoc -a toc api.txt
+# +# Create page for each part of API description +# +$(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
diff --git a/doc/api_links.txt b/doc/api_links.txt new file mode 100644 index 0000000..b4ef4d2 --- /dev/null +++ b/doc/api_links.txt @@ -0,0 +1,48 @@ +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:context.html[Context] + + + The Context is description of in-memory bitmap including some meta-data + (size, pixel format, etc...). + + +. link:gamma.html[Gamma correction] + + + The gama correction description and hanlding 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/filters.txt b/doc/filters.txt index 074e7d4..d9ac4fe 100644 --- a/doc/filters.txt +++ b/doc/filters.txt @@ -492,8 +492,8 @@ O(x,y)=sum_{i=-infty}^{infty}sum_{j=-infty}^{infty}I(x+i,y+j) cdot K(i,j) -------------------------------------------------------------------------------
The K denotes convolution kernel and in practice, due to computational -complexity, the i and j are bounded in relatively small intervals. For example -i and j are in (-1,1) and the kernel size is 3x3. +complexity i and j are bounded in relatively small intervals. For example i +and j are in (-1,1) and the kernel size is 3x3.
Note that pixel values outside the image are undefined. The linear convolution in GFXprim simply uses the closest border pixel values for all pixels outside
http://repo.or.cz/w/gfxprim.git/commit/14fa043cbe2545c0970092ffaef9ead7ef29f...
commit 14fa043cbe2545c0970092ffaef9ead7ef29fe02 Author: Cyril Hrubis metan@ucw.cz Date: Fri Jul 6 15:09:22 2012 +0200
doc: More spellchecks + v4l2 examples.
diff --git a/doc/examples.txt b/doc/examples.txt index cbd4cf5..683b9f5 100644 --- a/doc/examples.txt +++ b/doc/examples.txt @@ -99,6 +99,24 @@ include::../demos/c_simple/backend_example.c[] include::../demos/c_simple/showimage.c[] ------------------------------------------------------------------
+Grabbers +-------- + +Simple C source that saves JPEG images from V4L2 device (web camera). + +[source,c] +------------------------------------------------------------------ +include::../demos/c_simple/v4l2_grab.c[] +------------------------------------------------------------------ + +Simple C source that shows filters interactively on image stream from a +camera. + +[source,c] +------------------------------------------------------------------ +include::../demos/c_simple/v4l2_show.c[] +------------------------------------------------------------------ + GFXprim + PyGTK ---------------
diff --git a/doc/grabbers.txt b/doc/grabbers.txt index 571cc06..e7112cc 100644 --- a/doc/grabbers.txt +++ b/doc/grabbers.txt @@ -22,7 +22,7 @@ The grabber API consist GP_Grabber structure and of several functions: ------------------------------------------------------------------------------- typdef struct GP_Grabber { /* - * Currently loaded frame frame. + * Currently loaded frame. */ GP_Context *frame; @@ -38,7 +38,8 @@ typdef struct GP_Grabber { -------------------------------------------------------------------------------
The frame is a pointer to currently loaded frame. Its content is undefined -until you start the grabber with 'GP_GrabberStart()'. +until you start the grabber with 'GP_GrabberStart()' and receive frame with +'GP_GrabberPoll()'.
The 'fd' is a file descriptor suitable for select() or poll(). It's set to -1 if there is none. @@ -56,8 +57,6 @@ void GP_GrabberExit(GP_Grabber *backend); Exits the grabber, frees memory, unmaps memory mappings, closes file descriptors etc...
-Returns zero on success and non-zero on failure. - [source,c] ------------------------------------------------------------------------------- #include <grabbers/GP_Grabber.h> @@ -67,8 +66,8 @@ Returns zero on success and non-zero on failure. int GP_GrabberStart(struct GP_Grabber *self); -------------------------------------------------------------------------------
-Starts a grabber. After calling this calling you can start retrieving frames -with 'GP_GrabberPoll()'. +Starts a grabber. After calling this you can start retrieving frames with +'GP_GrabberPoll()'.
Returns zero on success and non-zero on failure.
@@ -84,6 +83,7 @@ int GP_GrabberStop(struct GP_Grabber *self); Stops a grabber. Call this when you doesn't need to receive frames but still plan to use the grabber later.
+Returns zero on success and non-zero on failure.
[source,c] -------------------------------------------------------------------------------
-----------------------------------------------------------------------
Summary of changes: doc/Makefile | 24 ++++++++++++++++++++---- doc/api_links.txt | 48 ++++++++++++++++++++++++++++++++++++++++++++++++ doc/examples.txt | 18 ++++++++++++++++++ doc/filters.txt | 4 ++-- doc/grabbers.txt | 12 ++++++------ 5 files changed, 94 insertions(+), 12 deletions(-) create mode 100644 doc/api_links.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.