getWrap.lua 819 B

12345678910111213141516171819202122232425262728293031323334
  1. return {
  2. summary = 'Get the wrap mode of the Sampler.',
  3. description = [[
  4. Returns the wrap mode of the sampler, used to wrap or clamp texture coordinates when the extend
  5. outside of the 0-1 range.
  6. ]],
  7. arguments = {},
  8. returns = {
  9. x = {
  10. type = 'WrapMode',
  11. description = 'The wrap mode used in the horizontal direction.'
  12. },
  13. y = {
  14. type = 'WrapMode',
  15. description = 'The wrap mode used in the vertical direction.'
  16. },
  17. z = {
  18. type = 'WrapMode',
  19. description = 'The wrap mode used in the "z" direction, for 3D textures only.'
  20. }
  21. },
  22. variants = {
  23. {
  24. arguments = {},
  25. returns = { 'x', 'y', 'z' }
  26. }
  27. },
  28. related = {
  29. 'Sampler:getFilter',
  30. 'Sampler:getCompareMode',
  31. 'Sampler:getAnisotropy',
  32. 'Sampler:getMipmapRange'
  33. }
  34. }