finput VEX function

finput returns fully filtered pixel input.

Context: cop

See also: cinput, binput, ninput

  1. vector finput(int , int )

  2. vector4 finput(int , int )

  3. vector finput(float , float )

  4. vector4 finput(float , float )

  5. float finput(int , int , int )

  6. float finput(int , float , float )

  7. vector finput(int , int , int , int )

  8. vector4 finput(int , int , int , int )

  9. vector finput(int , int , float , float )

  10. vector4 finput(int , int , float , float )

  11. float finput(int , int , int , int , int )

  12. float finput(int , int , int , float , float )

  13. vector finput(int , int , int , int , int , int )

  14. vector4 finput(int , int , int , int , int , int )

  15. vector finput(int , int , int , float , float , int )

  16. vector4 finput(int , int , int , float , float , int )

  17. float finput(int , int , int , int , int , int , int )

  18. float finput(int , int , int , int , float , float , int )

finput returns fully filtered pixel input.

Point sampled input functions should be used whenever discrete pixel values are being modified, since these functions are much faster. Filtered functions should be used whenever UV coordinates are being transformed or deformed. If multiple subsamples are being read and combined, bilinear lookups can produce a similar result to finput but much faster.

Each function may take either floating point or integer UV coordinates. If floating point UVs are used, the values are interpreted as 0-1 UV values; that is, (0.5, 0.5) is the center of the image. If integer UVs are used, the values are considered to be in pixel units, ranging from (0,0) to (XRES-1, YRES-1).

Each input function can return a float, vector or vector4 value. If the channel does not exist, the value returned for it will be 0. Whenever possible, use the vector versions rather that multiple float versions.

There are three different complexity levels for each input function.

If not specified in the function, the input number is always 0, the plane index is the current cooked plane, the array index is the currently cooked array index, and the frame is the current frame. So, cinput(u, v) is the same as cinput(0, PL, u,v) is the same as cinput(0, PL, AI, u,v, F).