Commits

Lenard Lindstrom committed 4459d21

some small document changes

Comments (0)

Files changed (4)

docs/reST/ref/bufferproxy.rst

 .. class:: BufferProxy
 
    | :sl:`pygame object to export a surface buffer through an array protocol`
-   | :sg:`BufferProxy(<parent>) -> BufferProxy instance`
+   | :sg:`BufferProxy(<parent>) -> BufferProxy`
 
    :class:`BufferProxy` is a Pygame support type, designed as the return value
    of the :meth:`Surface.get_buffer` and :meth:`Surface.get_view` methods.
    .. attribute:: length
 
       | :sl:`The size, in bytes, of the exported buffer.`
-      | :sg:`length -> Int`
+      | :sg:`length -> int`
 
       The number of valid bytes of data exported. For discontinuous data,
       that is data which is not a single block of memory, the bytes within
    .. method:: write
 
       | :sl:`Write raw bytes to object buffer.`
-      | :sg:`write(buffer, offset=0) -> None`
+      | :sg:`write(buffer, offset=0)`
 
       Overwrite bytes in the parent object's data. The data must be C or F
       contiguous, otherwise a ValueError is raised. Argument `buffer` is a

docs/reST/ref/surface.rst

       and length in bytes. The data need not be contiguous. Any gaps are
       included in the length, but otherwise ignored.
 
-      This method implicitly locks the Surface. The lock will be released, once
-      the returned BufferProxy object is deleted.
+      This method implicitly locks the Surface. The lock will be released when
+      the returned BufferProxy object is garbage collected.
 
       New in Pygame 1.8.
 
       .. ## Surface.get_buffer ##
 
+   .. attribute:: _pixels_address
+
+      | :sl:`pixel buffer address`
+      | :sg:`_pixels_address -> int`
+
+      The starting address of the surface's raw pixel bytes.
+
+      New in Pygame 1.9.2
+
    .. ## pygame.Surface ##

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_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_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."
+#define DOC_BUFFERPROXYWRITE "write(buffer, offset=0)\nWrite raw bytes to object buffer."
 
 
 
 /*
 
 pygame.BufferProxy
- BufferProxy(<parent>) -> BufferProxy instance
+ BufferProxy(<parent>) -> BufferProxy
 pygame object to export a surface buffer through an array protocol
 
 pygame.BufferProxy.parent
 Return wrapped exporting object.
 
 pygame.BufferProxy.length
- length -> Int
+ length -> int
 The size, in bytes, of the exported buffer.
 
 pygame.BufferProxy.raw
 A copy of the exported buffer as a single block of bytes.
 
 pygame.BufferProxy.write
- write(buffer, offset=0) -> None
+ write(buffer, offset=0)
 Write raw bytes to object buffer.
 
 */

src/doc/surface_doc.h

 
 #define DOC_SURFACEGETBUFFER "get_buffer() -> BufferProxy\nacquires a buffer object for the pixels of the Surface."
 
+#define DOC_SURFACEPIXELSADDRESS "_pixels_address -> int\npixel buffer address"
+
 
 
 /* Docs in a comment... slightly easier to read. */
  get_buffer() -> BufferProxy
 acquires a buffer object for the pixels of the Surface.
 
+pygame.Surface._pixels_address
+ _pixels_address -> int
+pixel buffer address
+
 */