File: bufferproxy_doc.h

package info (click to toggle)
pygame 2.6.1-4
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 43,076 kB
  • sloc: ansic: 66,932; python: 48,797; javascript: 1,153; objc: 224; sh: 121; makefile: 59; cpp: 25
file content (34 lines) | stat: -rw-r--r-- 1,149 bytes parent folder | download | duplicates (5)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
/* Auto generated file: with makeref.py .  Docs go in docs/reST/ref/ . */
#define DOC_PYGAMEBUFFERPROXY "BufferProxy(<parent>) -> BufferProxy\npygame object to export a surface buffer through an array protocol"
#define DOC_BUFFERPROXYPARENT "parent -> Surface\nparent -> <parent>\nReturn wrapped exporting object."
#define DOC_BUFFERPROXYLENGTH "length -> int\nThe size, in bytes, of the exported buffer."
#define DOC_BUFFERPROXYRAW "raw -> bytes\nA copy of the exported buffer as a single block of bytes."
#define DOC_BUFFERPROXYWRITE "write(buffer, offset=0)\nWrite raw bytes to object buffer."


/* Docs in a comment... slightly easier to read. */

/*

pygame.BufferProxy
 BufferProxy(<parent>) -> BufferProxy
pygame object to export a surface buffer through an array protocol

pygame.BufferProxy.parent
 parent -> Surface
 parent -> <parent>
Return wrapped exporting object.

pygame.BufferProxy.length
 length -> int
The size, in bytes, of the exported buffer.

pygame.BufferProxy.raw
 raw -> bytes
A copy of the exported buffer as a single block of bytes.

pygame.BufferProxy.write
 write(buffer, offset=0)
Write raw bytes to object buffer.

*/