class_colorarray.rst 2.6 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667
  1. .. _class_ColorArray:
  2. ColorArray
  3. ==========
  4. Category: Built-In Types
  5. ------------------------
  6. Brief Description
  7. -----------------
  8. Array of Colors
  9. Member Functions
  10. ----------------
  11. +--------------------------------------+-----------------------------------------------------------------------------------------------------------+
  12. | void | :ref:`push_back<class_ColorArray_push_back>` **(** :ref:`Color<class_color>` color **)** |
  13. +--------------------------------------+-----------------------------------------------------------------------------------------------------------+
  14. | void | :ref:`resize<class_ColorArray_resize>` **(** :ref:`int<class_int>` idx **)** |
  15. +--------------------------------------+-----------------------------------------------------------------------------------------------------------+
  16. | void | :ref:`set<class_ColorArray_set>` **(** :ref:`int<class_int>` idx, :ref:`Color<class_color>` color **)** |
  17. +--------------------------------------+-----------------------------------------------------------------------------------------------------------+
  18. | :ref:`int<class_int>` | :ref:`size<class_ColorArray_size>` **(** **)** |
  19. +--------------------------------------+-----------------------------------------------------------------------------------------------------------+
  20. | :ref:`ColorArray<class_colorarray>` | :ref:`ColorArray<class_ColorArray_ColorArray>` **(** :ref:`Array<class_array>` from **)** |
  21. +--------------------------------------+-----------------------------------------------------------------------------------------------------------+
  22. Description
  23. -----------
  24. Array of Color, can only contains colors. Optimized for memory usage, can't fragment the memory.
  25. Member Function Description
  26. ---------------------------
  27. .. _class_ColorArray_push_back:
  28. - void **push_back** **(** :ref:`Color<class_color>` color **)**
  29. Append a value to the array.
  30. .. _class_ColorArray_resize:
  31. - void **resize** **(** :ref:`int<class_int>` idx **)**
  32. Resize the array.
  33. .. _class_ColorArray_set:
  34. - void **set** **(** :ref:`int<class_int>` idx, :ref:`Color<class_color>` color **)**
  35. Set an index in the array.
  36. .. _class_ColorArray_size:
  37. - :ref:`int<class_int>` **size** **(** **)**
  38. Return the array size.
  39. .. _class_ColorArray_ColorArray:
  40. - :ref:`ColorArray<class_colorarray>` **ColorArray** **(** :ref:`Array<class_array>` from **)**
  41. Create from a generic array.