home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2002 November / SGI IRIX Base Documentation 2002 November.iso / usr / share / catman / p_man / cat3dm / fx / dmFXGetDataPtr.z / dmFXGetDataPtr
Encoding:
Text File  |  2002-10-03  |  5.1 KB  |  133 lines
  1.  
  2.  
  3.  
  4. ddddmmmmFFFFXXXXGGGGeeeettttDDDDMMMMBBBBuuuuffffffffeeeerrrr((((3333ddddmmmm))))                                      ddddmmmmFFFFXXXXGGGGeeeettttDDDDMMMMBBBBuuuuffffffffeeeerrrr((((3333ddddmmmm))))
  5.  
  6.  
  7.  
  8. NNNNAAAAMMMMEEEE
  9.      ddddmmmmFFFFXXXXGGGGeeeettttDDDDaaaattttaaaaPPPPttttrrrr, ddddmmmmFFFFXXXXGGGGeeeettttRRRRoooowwwwLLLLeeeennnnggggtttthhhh - return a pointer to the pixels stored
  10.      in a DMfxbuffer
  11.  
  12.  
  13. SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  14.      ####iiiinnnncccclllluuuuddddeeee <<<<ddddmmmmeeeeddddiiiiaaaa////ffffxxxx____bbbbuuuuffffffffeeeerrrr....hhhh>>>>
  15.  
  16.      vvvvooooiiiidddd**** ddddmmmmFFFFXXXXGGGGeeeettttDDDDaaaattttaaaaPPPPttttrrrr
  17.            (((( DDDDMMMMffffxxxxbbbbuuuuffffffffeeeerrrr**** ffffxxxxbbbbuuuuffffffffeeeerrrr ))))
  18.  
  19.      iiiinnnntttt ddddmmmmFFFFXXXXGGGGeeeettttRRRRoooowwwwLLLLeeeennnnggggtttthhhh
  20.            (((( DDDDMMMMffffxxxxbbbbuuuuffffffffeeeerrrr**** ffffxxxxbbbbuuuuffffffffeeeerrrr ))))
  21.  
  22.  
  23. PPPPAAAARRRRAAAAMMMMEEEETTTTEEEERRRRSSSS
  24.      _f_x_b_u_f_f_e_r   A buffer that was created with ddddmmmmFFFFXXXXAAAAllllllllooooccccaaaatttteeeeIIIImmmmaaaaggggeeeeBBBBuuuuffffffffeeeerrrrssss.
  25.  
  26.  
  27. DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  28.      These functions are used to access the pixels stored in a _D_M_f_x_b_u_f_f_e_r.
  29.      Before calling them, you must first set up the buffer.  To read pixels
  30.      from the buffer, call ddddmmmmFFFFXXXXSSSSeeeettttuuuuppppIIIInnnnppppuuuuttttIIIImmmmaaaaggggeeeeBBBBuuuuffffffffeeeerrrrWWWWiiiitttthhhhUUUUssssaaaaggggeeee, and specify
  31.      bbbbuuuuffffIIIInnnnppppuuuuttttDDDDiiiirrrreeeecccctttt.  To write pixels into a buffer, call
  32.      ddddmmmmFFFFXXXXSSSSeeeettttuuuuppppOOOOuuuuttttppppuuuuttttIIIImmmmaaaaggggeeeeBBBBuuuuffffffffeeeerrrr and specify bbbbuuuuffffOOOOuuuuttttppppuuuuttttDDDDiiiirrrreeeecccctttt.
  33.  
  34.  
  35.      After the buffer has been set up for input or output access,
  36.      ddddmmmmFFFFXXXXGGGGeeeettttDDDDaaaattttaaaaPPPPttttrrrr will return a pointer to the first pixel in the buffer,
  37.      the one at the upper-left corner of the image.
  38.  
  39.  
  40.      When _D_M_f_x_b_u_f_f_e_rs are allocated, they may be bigger than necessary to hold
  41.      the requested images.  ddddmmmmFFFFXXXXGGGGeeeettttRRRRoooowwwwLLLLeeeennnnggggtttthhhh will return the number of pixels
  42.      to skip to get from the beginning of one row to the beginning of the
  43.      next.
  44.  
  45.  
  46.      If the buffer has not been set up correctly for direct access,
  47.      ddddmmmmFFFFXXXXGGGGeeeettttDDDDaaaattttaaaaPPPPttttrrrr will return NULL and ddddmmmmFFFFXXXXGGGGeeeettttRRRRoooowwwwLLLLeeeennnnggggtttthhhh will return 0.
  48.  
  49.  
  50.      Under normal circumstances, ddddmmmmFFFFXXXXGGGGeeeettttRRRRoooowwwwLLLLeeeennnnggggtttthhhh will return the width of the
  51.      buffer, as requested when it was created.  Applications that use
  52.      DMfxbuffers can count on this.  It can be useful, when debugging plugins,
  53.      to create buffers that have a larger internal width.  If you are using
  54.      the debug version of libfxplugutils, setting the environment variable
  55.      FFFFXXXX____SSSSTTTTRRRRAAAANNNNGGGGEEEE____RRRROOOOWWWWBBBBYYYYTTTTEEEESSSS to YYYYEEEESSSS will cause it to create buffers where the
  56.      width of the storage area is greater than is needed.
  57.  
  58.  
  59.  
  60.  
  61.  
  62.  
  63.                                                                         PPPPaaaaggggeeee 1111
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. ddddmmmmFFFFXXXXGGGGeeeettttDDDDMMMMBBBBuuuuffffffffeeeerrrr((((3333ddddmmmm))))                                      ddddmmmmFFFFXXXXGGGGeeeettttDDDDMMMMBBBBuuuuffffffffeeeerrrr((((3333ddddmmmm))))
  71.  
  72.  
  73.  
  74. SSSSEEEEEEEE AAAALLLLSSSSOOOO
  75.      dmFXAllocateImageBuffers(3dm), dmFXSetupInputImageBuffer(3dm),
  76.      dmFXSetupOutputImageBuffer(3dm), DMbuffer(4).
  77.  
  78.  
  79.  
  80.  
  81.  
  82.  
  83.  
  84.  
  85.  
  86.  
  87.  
  88.  
  89.  
  90.  
  91.  
  92.  
  93.  
  94.  
  95.  
  96.  
  97.  
  98.  
  99.  
  100.  
  101.  
  102.  
  103.  
  104.  
  105.  
  106.  
  107.  
  108.  
  109.  
  110.  
  111.  
  112.  
  113.  
  114.  
  115.  
  116.  
  117.  
  118.  
  119.  
  120.  
  121.  
  122.  
  123.  
  124.  
  125.  
  126.  
  127.  
  128.  
  129.                                                                         PPPPaaaaggggeeee 2222
  130.  
  131.  
  132.  
  133.