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 94726f09c80a120c03ee251338f2a2800bdaa076 (commit) from 951e4bf59ad725f05fce1600e8da2ca8f4a8f8c0 (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/94726f09c80a120c03ee251338f2a2800bdaa... commit 94726f09c80a120c03ee251338f2a2800bdaa076 Author: Cyril Hrubis <metan@ucw.cz> Date: Thu Dec 20 15:53:05 2012 +0100 doc: Add clear bitendian definition. diff --git a/doc/.gitignore b/doc/.gitignore index 4b4703c..670b96a 100644 --- a/doc/.gitignore +++ b/doc/.gitignore @@ -9,3 +9,7 @@ discrete_linear_convolution_alg2.png laplacian_edge_sharpening.png laplacian_kernel.png +bit-endian-be-1bit.png +bit-endian-be-2bits.png +bit-endian-le-1bit.png +bit-endian-le-2bits.png diff --git a/doc/README b/doc/README index ae93336..400ede1 100644 --- a/doc/README +++ b/doc/README @@ -2,4 +2,5 @@ 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. +In order to do that asciidoc and source-highlight, latex and dvipng and +graphviz must be installed. diff --git a/doc/gen.txt b/doc/gen.txt index 28b438d..949f585 100644 --- a/doc/gen.txt +++ b/doc/gen.txt @@ -38,13 +38,98 @@ per pixel. It also contains suffix that is a string used as a suffix for functions that manipulates with this pixel size. The 'bit_endian' determines direction of bits in bitmaps and graymaps (i.e. -most significant bit left or right). It can be either 'BE' or 'LE'. - -Note that different pixels can share the same pixel size as for certain types -of operations the function doesn't depend on actual arrangements of the color -channels in pixel (i.e. Get/Put Pixel, Rotate buffer 90 degrees, etc...). - -TODO: Which bit endian is which? +most significant bit left or right). It can be either 'BE' or 'LE'. To avoid +confusion following two figures describes bits layout in 1 bit and 2 bits +grayscale bitmaps. The rectangles in the figures represents bytes as they are +in the buffer. The start of the image (i.e. topleft corner and coodinate 0,0) +is on the left side. The numbers describes position of the bit in the byte (as +seen by shifts and bitmask from within C language implementation). + +BE +~~ + +["graphviz", "bit-endian-be-1bit.png"] +------------------------------------------------------------------------------ +digraph bit_endian { + node [shape = record]; + rankdir = LR; + + node0 [label = "{<e> ...}"]; + node1 [label = "{7 | 6 | 5 | 4 | 3 | 2 | 1 | <e> 0}"]; + node2 [label = "{<b> 7 | 6 | 5 | 4 | 3 | 2 | 1 | <e> 0}"]; + node3 [label = "{<b> 7 | 6 | 5 | 4 | 3 | 2 | 1 | <e> 0}"]; + node4 [label = "{<b> ...}"]; + + node0:e -> node1:b; + node1:e -> node2:b; + node2:e -> node3:b; + node3:e -> node4:b; +} +------------------------------------------------------------------------------ + +["graphviz", "bit-endian-be-2bits.png"] +------------------------------------------------------------------------------ +digraph bit_endian { + node [shape = record]; + rankdir = LR; + + node0 [label = "{<e> ...}"]; + node1 [label = "{7 6 | 5 4 | 3 2 | <e> 1 0}"]; + node2 [label = "{<b> 7 6 | 5 4 | 3 2 | <e> 1 0}"]; + node3 [label = "{<b> 7 6 | 5 4 | 3 2 | <e> 1 0}"]; + node4 [label = "{<b> ...}"]; + + node0:e -> node1:b; + node1:e -> node2:b; + node2:e -> node3:b; + node3:e -> node4:b; +} +------------------------------------------------------------------------------ + +LE +~~ + +["graphviz", "bit-endian-le-1bit.png"] +------------------------------------------------------------------------------ +digraph bit_endian { + node [shape = record]; + rankdir = LR; + + node0 [label = "{<e> ...}"]; + node1 [label = "{0 | 1 | 2 | 3 | 4 | 5 | 6 | <e> 7}"]; + node2 [label = "{<b> 0 | 1 | 2 | 3 | 4 | 5 | 6 | <e> 7}"]; + node3 [label = "{<b> 0 | 1 | 2 | 3 | 4 | 5 | 6 | <e> 7}"]; + node4 [label = "{<b> ...}"]; + + node0:e -> node1:b; + node1:e -> node2:b; + node2:e -> node3:b; + node3:e -> node4:b; +} +------------------------------------------------------------------------------ + +["graphviz", "bit-endian-le-2bits.png"] +------------------------------------------------------------------------------ +digraph bit_endian { + node [shape = record]; + rankdir = LR; + + node0 [label = "<e> ..."]; + node1 [label = "{0 1 | 2 3 | 4 5 | <e> 6 7}"]; + node2 [label = "{<b> 0 1 | 2 3 | 4 5 | <e> 6 7}"]; + node3 [label = "{<b> 0 1 | 2 3 | 4 5 | <e> 6 7}"]; + node4 [label = "{<b> ...}"]; + + node0:e -> node1:b; + node1:e -> node2:b; + node2:e -> node3:b; + node3:e -> node4:b; +} +------------------------------------------------------------------------------ + +NOTE: Different pixels can share the same pixel size as for certain types + of operations the function doesn't depend on actual arrangements of the + color channels in pixel (i.e. Get/Put Pixel, Rotate buffer 90 degrees, etc...). TODO: Rename size to bpp? ----------------------------------------------------------------------- Summary of changes: doc/.gitignore | 4 ++ doc/README | 3 +- doc/gen.txt | 99 ++++++++++++++++++++++++++++++++++++++++++++++++++++---- 3 files changed, 98 insertions(+), 8 deletions(-) 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.")