Source

pygame / src / doc / bufferproxy_doc.h

/* Auto generated file: with makeref.py .  Docs go in src/ *.doc . */
#define DOC_PYGAMEBUFFERPROXY "BufferProxy(<parent>) -> BufferProxy instance\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) -> None\nWrite raw bytes to object buffer."



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

/*

pygame.BufferProxy
 BufferProxy(<parent>) -> BufferProxy instance
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) -> None
Write raw bytes to object buffer.

*/