getIndices.lua 578 B

12345678910111213141516171819202122232425
  1. return {
  2. summary = 'Get the vertex indices in the Mesh.',
  3. description = 'Returns a table with the Mesh\'s vertex indices.',
  4. arguments = {},
  5. returns = {
  6. t = {
  7. type = 'table',
  8. description = 'A table of numbers with the 1-based vertex indices.'
  9. }
  10. },
  11. variants = {
  12. {
  13. arguments = {},
  14. returns = { 't' }
  15. }
  16. },
  17. notes = [[
  18. This function will be very very slow if the Mesh's storage is `gpu`, because the data needs to
  19. be downloaded from the GPU.
  20. ]],
  21. related = {
  22. 'Mesh:getIndexBuffer',
  23. 'Mesh:setIndexBuffer'
  24. }
  25. }