class_streampeerbuffer.rst 3.6 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182
  1. .. Generated automatically by doc/tools/makerst.py in Godot's source tree.
  2. .. DO NOT EDIT THIS FILE, but the StreamPeerBuffer.xml source instead.
  3. .. The source is found in doc/classes or modules/<name>/doc_classes.
  4. .. _class_StreamPeerBuffer:
  5. StreamPeerBuffer
  6. ================
  7. **Inherits:** :ref:`StreamPeer<class_StreamPeer>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
  8. **Category:** Core
  9. Brief Description
  10. -----------------
  11. Properties
  12. ----------
  13. +-------------------------------------------+---------------------------------------------------------------+
  14. | :ref:`PoolByteArray<class_PoolByteArray>` | :ref:`data_array<class_StreamPeerBuffer_property_data_array>` |
  15. +-------------------------------------------+---------------------------------------------------------------+
  16. Methods
  17. -------
  18. +-------------------------------------------------+--------------------------------------------------------------------------------------------+
  19. | void | :ref:`clear<class_StreamPeerBuffer_method_clear>` **(** **)** |
  20. +-------------------------------------------------+--------------------------------------------------------------------------------------------+
  21. | :ref:`StreamPeerBuffer<class_StreamPeerBuffer>` | :ref:`duplicate<class_StreamPeerBuffer_method_duplicate>` **(** **)** const |
  22. +-------------------------------------------------+--------------------------------------------------------------------------------------------+
  23. | :ref:`int<class_int>` | :ref:`get_position<class_StreamPeerBuffer_method_get_position>` **(** **)** const |
  24. +-------------------------------------------------+--------------------------------------------------------------------------------------------+
  25. | :ref:`int<class_int>` | :ref:`get_size<class_StreamPeerBuffer_method_get_size>` **(** **)** const |
  26. +-------------------------------------------------+--------------------------------------------------------------------------------------------+
  27. | void | :ref:`resize<class_StreamPeerBuffer_method_resize>` **(** :ref:`int<class_int>` size **)** |
  28. +-------------------------------------------------+--------------------------------------------------------------------------------------------+
  29. | void | :ref:`seek<class_StreamPeerBuffer_method_seek>` **(** :ref:`int<class_int>` position **)** |
  30. +-------------------------------------------------+--------------------------------------------------------------------------------------------+
  31. Property Descriptions
  32. ---------------------
  33. .. _class_StreamPeerBuffer_property_data_array:
  34. - :ref:`PoolByteArray<class_PoolByteArray>` **data_array**
  35. +----------+-----------------------+
  36. | *Setter* | set_data_array(value) |
  37. +----------+-----------------------+
  38. | *Getter* | get_data_array() |
  39. +----------+-----------------------+
  40. Method Descriptions
  41. -------------------
  42. .. _class_StreamPeerBuffer_method_clear:
  43. - void **clear** **(** **)**
  44. .. _class_StreamPeerBuffer_method_duplicate:
  45. - :ref:`StreamPeerBuffer<class_StreamPeerBuffer>` **duplicate** **(** **)** const
  46. .. _class_StreamPeerBuffer_method_get_position:
  47. - :ref:`int<class_int>` **get_position** **(** **)** const
  48. .. _class_StreamPeerBuffer_method_get_size:
  49. - :ref:`int<class_int>` **get_size** **(** **)** const
  50. .. _class_StreamPeerBuffer_method_resize:
  51. - void **resize** **(** :ref:`int<class_int>` size **)**
  52. .. _class_StreamPeerBuffer_method_seek:
  53. - void **seek** **(** :ref:`int<class_int>` position **)**