From cea74d92ea4e053531743cb50eef03015d0d57ac Mon Sep 17 00:00:00 2001 From: Neil Roberts Date: Fri, 2 Jul 2010 16:19:48 +0100 Subject: [PATCH] Convert the ASCII art documentation in cogl-vertex-buffer to PNGs The documentation for cogl_vertex_buffer_indices_get_for_quads was using ugly ASCII art to draw the diagrams. These have now been replaced with PNG figures. --- cogl/cogl-vertex-buffer.h | 31 +++++++----------- doc/reference/cogl/Makefile.am | 4 +++ doc/reference/cogl/quad-indices-order.png | Bin 0 -> 2620 bytes doc/reference/cogl/quad-indices-triangles.png | Bin 0 -> 8018 bytes 4 files changed, 16 insertions(+), 19 deletions(-) create mode 100644 doc/reference/cogl/quad-indices-order.png create mode 100644 doc/reference/cogl/quad-indices-triangles.png diff --git a/cogl/cogl-vertex-buffer.h b/cogl/cogl-vertex-buffer.h index 758534898..6184257bc 100644 --- a/cogl/cogl-vertex-buffer.h +++ b/cogl/cogl-vertex-buffer.h @@ -421,27 +421,20 @@ cogl_vertex_buffer_unref (CoglHandle handle) G_GNUC_DEPRECATED; * * 0, 1, 2, 0, 2, 3, 4, 5, 6, 4, 6, 7 ... etc * - * For example, if you submit vertices for a quad like this: + * For example, if you submit vertices for a quad like like that shown + * in then you can request 6 + * indices to render two triangles like those shown in . * - * |[ - * 0 3 - * ######## - * # # - * # # - * ######## - * 1 2 - * ]| + *
+ * Example of vertices submitted to form a quad + * + *
* - * Then you can request 6 indices to render two triangles like this: - * - * |[ - * 0 0 3 - * ## ######## - * # ## ## # - * # ## ## # - * ######## ## - * 1 2 2 - * ]| + *
+ * Illustration of the triangle indices that will be generated + * + *
* * Returns: A %CoglHandle containing the indices. The handled is * owned by Cogl and should not be modified or unref'd. diff --git a/doc/reference/cogl/Makefile.am b/doc/reference/cogl/Makefile.am index 8ca7830d9..74d96eacf 100644 --- a/doc/reference/cogl/Makefile.am +++ b/doc/reference/cogl/Makefile.am @@ -94,6 +94,8 @@ EXTRA_HFILES= HTML_IMAGES = \ fill-rule-non-zero.png \ fill-rule-even-odd.png \ + quad-indices-order.png \ + quad-indices-triangles.png \ cogl_ortho.png # Extra SGML files that are included by $(DOC_MAIN_SGML_FILE). @@ -125,4 +127,6 @@ include $(top_srcdir)/gtk-doc.make EXTRA_DIST += \ fill-rule-non-zero.png \ fill-rule-even-odd.png \ + quad-indices-triangles.png \ + quad-indices-order.png \ cogl_ortho.png diff --git a/doc/reference/cogl/quad-indices-order.png b/doc/reference/cogl/quad-indices-order.png new file mode 100644 index 0000000000000000000000000000000000000000..a31d95d48777358e396de9c58b4ca990cdb46c12 GIT binary patch literal 2620 zcmeHJc~sJS76%kj1Cz4cN)a`)%ndaPuu@de)Jc1lxlt-eE>I|HEi+|4z8yuaqp`EUN3?>YD0bGLKuxu0{-=X?2YL4F8* zGkp*UgdmfMAsXAMk>7N6G#VdV_DN&3SzhGBx|)}z8_U!9dQ4InOH<$Tmw>&t-%i&A zO;dc1rGzr5DQPFp#DUV%(j4i@39OhC%s5BJ8QSe}yqTu4kxV>rIK52WpK&!Z&XhAX zy!E&})F>?W5L@^Wm4DGz_qg_k8}Xo45Yo`6zQHD*w02q#jL_L=bqf`*tz}>3d-;yT z@l8gBLX@t)?fLV%jwn=I((+Qro~}KZ@-IgQ_>G|z(XL!*B~dgnJ{Js)$`)>&H21AH^dlX44w#C+1g;<;EGvmQ0(n5L=S3lwOpc)Au8xWkvk8u(|;X2`R=g*VUY$U6O!;wVJ?MH! zGw-hxN|%U42T(GETIc-~6hN;iQo|Gb`7K5t8P4~)-@)B5QOx!`wg8*om`xogv*K}* z8Po$}`|0B8UQ!ndT@MzW*na0FAm=wGP%W{z6lz4`2ZPmO)t;fBU0Jrw4BE(u`(V<; zi7{=w56d;lbn=m&YOptKKu0iqVL4UDn3lO>)-fcXZY8MizwdCJ0aJ2_QgFRoT55MJ zE>Auk`gTjvcQstZ&dD-5_sxN^8EHQMtTsgQT561$X`NCL+f{Ie$|K%OA;v6_)|-dx z;JZu(Jxn&0OSRhU+!!~L2r6>ZFB3bS|L9PEJMZ%6F6O%nTM@haBkl7#~p~2V1!6=KhsWT z*jwPTdO$gf6n_)8feg#_c4qbgMA~;@U28U=2Y`XoZVW{WTnhd>EcqIbP?d3NK4MvG z?^;mo3;A>{6z4EkE?r3-?j3~Wqlaz-1@S?hNd_w@v_PDxu*qSW)v1jGFxh!voGXGLqY^9rQ|S*JPP9ZKXU#DQ9>33kodHLelNpoNSla)QX6ed{WmA zwCDP=e$(T=UBG8IyCId!dl-q0-@R!5u}E`eWqfc#&E@m3H&qvM z>dk11E+CAb@%5KE-vL8&5B&|u^)>0eMN%SRPtmrb6>xY3tAtcvk(=GR@lA}+vOBXf>ma)RGOeoVo z(>Az~yf2~0cXpRjNbWCm6HkEbf_)E$B0KTGe8qbwHho`M-TTAMzE>_kAcayxRxKX< z+r3jaz%<7x&y7ERe^GLE+lQ2kB{4rrO+)H|4Sm(( zb>LYNf6o?+`fS8*dgR$jTQ)#2*EHH^eZU9jwZR+@~o;h>wt!zy4$5$ z(1ypD=b7`o6!*#R>V4!-K=9(`bzQlN5*+6H%lMu+hf*0 z?Q@|gZ9+~|?b+ipa%3?6M)!WA6zZs>6Fq|mMI@0z3eYD#CbKCM?0C)HQyq8PJcJ=# z@>PL~`P5tu$I6@umUo>r%197p?J^otK-vI8itU+D*$%%a6xD_7kcFa1$ygEhI;znH^OvBu7- iLUDTR^7K~=tFVxb$A9t|_ej$G^gv{vAfm{Na{f;SUWiKo literal 0 HcmV?d00001 diff --git a/doc/reference/cogl/quad-indices-triangles.png b/doc/reference/cogl/quad-indices-triangles.png new file mode 100644 index 0000000000000000000000000000000000000000..18c42c845ed165d3b15dbd431f905be823416276 GIT binary patch literal 8018 zcmXw82|UyP|KH4zGs%5tqH?y8ifK8roRyL!d@;#LlKa|xBloO>k)s;A97W`wq){81 zkX&MLlAl^duTjZ!{x+Wic{QJ+JFrVw+ zJ7={!h9hySv+Lpc#$7{8c>|jxL&Kq+jQdL_dy_i#DxowRGI}bwq|nU+*Ggc1U4y&XC{Iy|CXvDHU+pFj>u z8_CNIwMC{uLrBYZS8e&z2o$E^hOFtMa~udqqXMO;*Z&7nQAX`z9Tq0~wlWNPEMfl6 zJy|p%+8}Kg4PQH~3_F*#tX~V$tDJ*Lvo6WF!OQ58687INxkt05kn)bJqX^9uKVRL{ zt582^<;e@8%^OBLw;Z6)q4)0%dF-@N$5k8Ykynm{%2$x6ZR(|aeM8)x*o`)BN=C8o z7sz^*W2P<=N&~jb&!JB=rsB988H36Qz6}%c?Y38RRo{ zu7(ysQ>-KQ-R)AzzQCBd;!dBTpCFuFGSIFW#nB$m&~@V;kpH+od7Sw1lFSL1saDf1 zsyt!tdyc3<<>CL9{CL%a90S(xU$`k=ys=r%j8Wj-cwC+aZ>jnRhh&RM9Z+z5rpIGd zC&}?!nKjW>ox z;FwL$-g(hK6<=*P2tiK9d4rdDH+K0-x)(oRIE;<`@y#Nj-JdQ^t#u}>Bx-kAN7UwS z(#NtsL4iWy|88ZT$@QTp5@LdC<3w1fWqL?iK`7_wM8kV>+ zZshf)lu!M(Zu;$rFq@d>@=qVFcT(M9>{Wv=CwTa+B5GLO@2a9P=nifo!aKHpnob9o zr@tLVU&cwzP@|D->4D7?g>^zqz}>Im71g4shOp+6w? z6RkZ>H2dX9sF*j>PbPcE-P}x*=tX0dnoVCtVg9cqF;aF}BAr1Rj4AJFBo;z5gMA)M zA4JMShjd;X6mq^TuKMN2Ka7vR2^ioae}ZquJ~vWgJ?jO?!xuJC?gWH;K{ zpQ~S^=tlacz6A;BR8m4Z1swgef@wa+a;2%&7QY&tGD1!GnM9Rt#BdME@9!VaHjGCPp(8Lo1Vn;0>bij~1cHk^y5yYfY4a#5{ixjNr|{i(;>azSv5x z8oe5WW#vZu>j@NR4igHz2SZ^d`_f0>``hDTvmFM)U43cO$z!!Yrw*g^opU0;&Rylm z$-BO=4p^^7>r3+f@~{brd`)5YPUpu_m|{^H{iqk()?-iJ{$f~4>w7s{ei^AP{!!9- zwL9)&=HQVyBL~U z(0aZ%?(Ay8%ij7J>-DOZB=Wo6t3o;HKiW@Q#f2028Ti@_QC#)Dku%RzZ#G!6gr>Fl zT0W^xU*BNWz4?X4bI zLk+tcX_luH*7{C!Wgj_>A8OQqz&6>|L6l;?Sss$QZh zG!->oDX34Q+DifMtRbtg>)%7}3rCsL0|n!v)m#urA@w4kU*#qm zV!HLb!YfVRO5gl(MQhH5mZ6?@KM3#P+h;NV%cXyI5`Kv%{mydzr3g_u65gUiap7}u z+rsT}Yg#4kE_rr({PXaXOujttlb!R{*gVk#s7mMg+MdxjiKWqs&HH2cUMp@z#eN#g zzA!z8tLCZLhn~H5gnfA90aFuO@NLCqr%bmiE1Qz8dUtvxPm{s-p=iQPYVqIm_%=`)xEdOM9wSC>l2xGDViCq*M|;!*6co#cP`EQB)Cl#-v{&Az;tX>m$L$(-hWl71#LU?Tl`Hv8uN5S@n?lq(NY)bT@SLG_%=l(mT zFv^=eU6){5Q9H=^_M|nE*Ea6{8N!WenVbB2Vu2YHMM=Lre&#Wg?-WTL{?8YAEbomQA*EiV&TWfAG~k$c^b){SDwRuOHwiuA`iP=l;)T|l^*{h zlbvnSzJr)REn8Knl->OSCbpY8rC+5&Zo0FKj5?0FX1ffZC#Ar8jtUWHpRB`Vv0E)A z%K5+*&oP$r!aN!D`_908itANe+wXOZ!~W=nDmkp1)sbEH3*j{?P7%WV%WaYTX-U*9 zg29xLPU)L!8ZXjiZ|O6Ysr%@C>5_;vzH_t*&XO=sXNHoQpXxLc%Rh#^^2doJ4SVMe zmBKh2iN2r!MQlo(&r2uNNmj#^(turN(UDStjZzhnchb(ypBQ{j%CfxEQ%mClD${4M z>tlX*qRx|~`IYo5UC)H=kb_~ncn-j_`bnX5Q;C$l29mso$-C)-SUYvF&3R1(&BV*gQ}t{w9&?>wwu$^6vD=~&6$myH$w|3 zk2%ylZ&H~`Kb`Ce$7VsEji(&`N|Am2kV$ zI~_t+YE4|N%k1GGZEK#Ny|;t(zw<* zUBSiuVPS2ntfNBjkF$)T&M|+&JLb<<)idz3Phs(eb|~{}&sC=J?0U{Ww&6Jb0A%HD z=JN-}{LzWj(D{8Obca0gTB%IV?qyXGr^^VFe-oWj_gN*xVrLIl)|E+$qja3dd%6g} z=5KypVx(xGH&MF^h!H)3ZQ?2}s2DRg?^EQSem@7{7eJA;-Bplt-)egQB^8u zcNLVSye%m_gtEBy?>^bgM3@U?PIB@=ScXUQ;qqJ zeICtYCM1Md%QQI7ki}>sk2pK|3h3gSkad;Z(JzTxlPiFi9xt zsS|u}&icg}nrW7%T15#KClza@>#3^+xw&hw9}ydP^+p&We_^pj`|j>`$}IhDiTl&b zU&ha4SO#IdUwYuamh6+rdZP&8QnP!UD)|ZxZW)Nhx&R0HZ_I+rpQz5kjlFO}CEG}} zUI_o)we2dxyjc_2pvhGd6}t1jm`h4?`gjVswG=s@raUt2$aPg{y=Kd;{GJUDW(wR_ zAh42>=Z)j`_0rFzyT!eYZwJ@+*(m+;O278piTHPkMcc*r$VpC=5M-&a zop2%kz_+Nj3-FyWrssZuy-94?iT)W_u-r*}Nm|}jAs6T&5`NVEI7kDZwkrVonhE;y z#tS0KWZn;1|Am1&3CJT}OD!nY_)l47YP&1w<D8>B z>?wk9y&0>Tzt0K@b;=zOK<1(wD+`5R0&j%Iq}29%s>z-jRuQ|Jsdd!}4Z43Sa1W}= zhzB!+cg!oYZxS6lZW(JF+_NrrN}>K37{EgyE02z-1<8zfel`Z@Xdz6}O&jWK6E-~e zsJ$HB+4h3pN{*llT|14*fxm8JblysB@58Xx$<^;B=72@PuC^D6RylF2QYZRJu|#{5 zjSGJv$6sJIe+Bc@%RFBp$)0JwF;>ijog1(8Nv8sDH`v#ZE{AGg6rvC&srD9tvt?GsXGt#PKTXui4|PDAGR@Y?W5;qMMPtokGYcl&(wB06Q2f3dP&@k z?Q710g=LK86F>3Yzr{b@nK^XcK@jj9mbMn0FCK30Wo`%}jU-SHE$Fs(IMQ89Ge)!B z47Obl#}}ZKwX9$SH^?Ip%Hdn%pRHdiwO-?R_a24+{z2Qsg&T37p2}PH6EI=J< zL+)_`kk8)#(5P<*Hk56WkSN3ora9w6Dk&n^?cy&?3%Coh8;QodIhB;3Ss)-!U@VR; zXPX`EELFXlBqrykQ~IpX1~Gin(4$aAghvPD^c^T{UgmNw)hy0GPE2s|4XqVd?ey2X zM!xvrhY1aeN|#>-gXD&qUz<@w4F7A7jC`oVgj~eqoN@+Ixls8lrVF8MsqO0XRt@d9 z@G1|DR#eIP^pe}I7tBUvw~lLN_MLUuOST+OvbUF{0t-E0p$}R*pBCWgW3H3tcG@4@ z*+Gt+|4wMK*I?3Q!9|x#Tf39SvjwnDkOQzSO)EEOnL(ux1MdJXC~LK5#prKqZNAsqea3^qr&Ljck+ornZf!^#wYaEf&>C@Q}PsLGr#U^)93mQ zp+RXr@NkQ$xcTD0kk{WB8`d_MG>dzITlodxtC_B@I?ZF;@%<|ibpYKqgF?!a{>Sb2 zXdaFl=xF|e!hJ=J)fNHEpETRh z$g;U7UMm~8d)^y!Nn%d_dER#5N^k6QJOxk72Wsi<1&xxgnJ#kdo_M%ih3NbROuoFB zjmh5eG9Y|cq4GQ$T+J1YVWpR+6Vpyj^r92b= z4KUY1z{6rCA(oRw4uYs$6xwGBEZJ6T(iMDxmqfz-+=&$J+`p(8i+`sfMV%%HG4Wnr z<|`m{TW;uj725O7#0E_z$BGl%kc<#72njnS5*`WKrr-P;eh*?eZdK;b1ri^uS-0#2y+M%98V2k$ZHXsm}4GA}ia-If5rGSO&D3Cwb!G zMHE*B*~~NcyXkw)!CY4ltB2hdTs+8$ZujSgyeCUM+*Tx9m;Ipq*8L;kEPb*LIIBS0 z3OwOCRJo+4_VNaZHI!!sj@EAfFd>`iQXJZMAKWhpu_=;qr2aud6l6Y*qD|V4R_Bd! zU&DD)0_0HcfHP1N6R?g!$$vC_UDzsM6mojQFL3q#wiNFj7n`%}C5gdjGg8~jK=v|7 z!D#f}MK`#wp?ei2Pfj+oG@iPO@P{gJCFd!}@e@!~KT*(HNJJWaPIvemNjSrz9;^n~ z04+@stk3uvF+XqfkpP^ArKOj_f-*}ibJ@*Zf_)h{P6RW_Sdu?neb00k2fH*2s7--? zNLDse5qP%m0HO--gJ05ZUt*iIKiV_?)|5&Z5 z0k&!atk#LF{K1@gwynls_T$6vXmBGP0FWpSJ%>J};Ib2|3l51rYc?WPklSdptr~T3 zQ(yEsQZc_}_J9G-@JxiySMjzN7MaTwDvY4a?KPSF*-97g1t$;g(JfP*ivz54x9@B? zDDpMLrf5O#W(^S~^P0iXN!u1G4e|;!q!>hoHC78MS?**>wCNvXRfg4deKnXICY)g4 zKT?Z{r!#{M(7IdGM3h9}U5cw0uBRmQUb<#F6ik7OiL`vcZ81X4Vzst^(Jv_WQPJ6K zMBXjm6KE?-96W)EqgoT@AYiE5UN44j)n8Er*-|8IKF$+A{E<;@HTQfjX~_i!GeGfl;d;`!yx7YH_`Bu~Jl3+8lGn1}UFC;yenDe4IoTL-@lsWH=2f<;1S1 z1A5!?ya`vHz3wOSThIMDg_+fNmTNk-3){@w$9rj?RV6GIRe1(<k9pa>q4SEj#${{_$g^#c!m$8MaXoP^One`A90Q=upqFcn=(I15rG#%H8Y@RY zB-wirjeO5VHi%%NwVhwMdSLG%sXGbOqYJmcwZeT>0uw01EF0O(Qws6Edq3RT*jI6Q zJ^-VXOn2o9EfB3sK%l#xs9qHXn_NQC4FiAkYr+v})Q=oa%?|G7OQ5*=;oP`F4Z{{# zAKCpm2ROPJm&m|_8Lt>r9ODY+Jaqi{8@a_0un=4Y%jcbBYVHE%T!u6tMz`F7-n9GT zvYB0qb&=Z-M*&9}fPl~#7BWnUeU~e_ub5DysC-4)tjj#O=aCU# zbOJR){b#bzR`h97R%^kbKy7;0MpKUvcVqagw}7O? z)cwU~#G=lT62X4QLUIqpl9rABOfG(tTT~4j>h1sQ_$EgnF-wr8g*wKKLq(Q6l2v68 zs0sFk(U$LH0bKEwBJX84wtY01Y@L6SSmXs5LYS;Jtq>*E_6(>j+Yov5#lS=vF<))k zHEM;C33{k3p#ary{qq1i4ztfHLZ%=w(g$+|mJWNDJ#g{=l`_4nKekk*YsZiWj$UHy z3l0VA!C)Bq!vc4Bi(i#FXTMFMVr(_pS#2wS+K#YH8#1>dns>Ek|3iSswoKxN0oWLh zZqKuz3xCC(d2APTA;WwdI0?sC!yNCGcrKjkC}~%UUq34h_0nK^E*wY+6ZF1rp z(Q2S+^tglHwsPF^Q@=dDRd`T8qPvHxx?a_b5 z`2a^S`+ISe+wJ76|_i z41-B~^*9gXrpJ*x@3c&i@97SjJLuq6qS@itjNbKECBCO? zsNy(7S&m2ECNIXmwrbs#_$QqzzxLm&k|*C~cro3hNe_%MJ9!O2>+)hgc;I>{&RO== zk-^UXxF75e88PgdQ{Dy~GpvVfExD_mT%NUwnok~YItB51P#ZahER}*wLHO91di${+ z@vhq_bxOnF_+{JysMtg!<7egFuf#&t_CEQ;BAX?1BuJY_(KX7rFQgVGrUpY#;8&PmwrpS|;HQ{XWpU&hAf;$`)|_x=UL z&K}^Y5a0ZVi#>v8k{?k@2|mTH&?t33r9{(?9Yo82!UEPWVhcj5Jy(_&US8~}XgVl~ zQW$0Wn|_JkRPOQ@`!IUFLDEfEY9pU1OZ&))rWZv_=n4F1QB7mX)fP90R$onzovdzl zb~}MlBS+h<@P1?dv7Ku1_$^a~eWlcH^Y&5UY{v+-1|44*V3l)!SUHD(tK0Nre5+Ku ze=|$t9WmiJ%gdeNs8k&k5E<2Eln(36TBctD4;|5n`qY@i>-`dao&Fi+&5sHPI_zFY ze#`li@`yTDRI{5mI)x$vt7aN()@tcu%&znO?7A?*UzS$ei)mJue~%=t2ot_9@J_2_ z6Df)!GxzDy^-ySby?ei`|)BVLMU#2a1-h+*2+tVac8QfQ7r4M%VSY z_#oygB=fJtZBXP&6$;oh7#r10kF`(Do+;J(;8mN$u?QKFl z!qp-FSz%_oU4G5@0qJu_@*HgGP#56c9#7n}apkpv%Hj-yBBG5|3f1#2{V_gwHS&Rc7pjQS-p1@OUoBo`n=Zj$-ScJevTRw@sn=i*BT^ zbSQ{BlPxDc$BDiN2a-st?-XnH!EGENM}Is!ZBZ&^hRD1Nl(jR45;w@EGIyZr2CTJdV#geOD(hB$t*(P^~TSfg5Hg zPXIZwrAKfgS|z_s#r$e9evy8|ufpc4n+muj-kcoTEl~!UooQQGi#@-BjZkS({0%<; OhF~r1%*&3u6aNpuN&@u& literal 0 HcmV?d00001