Anonymous avatar Anonymous committed 360c7b7

Minor documentation updates

Comments (0)

Files changed (4)

doc/capi/openal.rst

 ^^^^^^^
 .. cmember:: ALCdevice* PyDevice.device
 
+  Pointer to the underlying OpenAL device.
+
 Functions
 ^^^^^^^^^
 .. cfunction:: int PyDevice_Check (PyObject *obj)
 .. ctype:: PyContext
 .. ctype:: PyContext_Type
 
-.. todo::
-
-  describe
+  PyContext objects represent logical state groups, where sources and a
+  listener are managed and audio data is correctly streamed to the
+  underlying output device.
 
 Members
 ^^^^^^^
 .. cmember:: ALCcontext* context
+
+  Pointer to the underlying OpenAL context.
+
 .. cmember:: PyObject* device
+
+  The :ctype:`PyDevice` bound to the context.
+
 .. cmember:: PyObject* listener
 
+  The :ctype:`PyListener` bound to the context. This will be NULL until
+  the first call to the :attr:`pygame2.openal.Context.listener`
+  property.
+
 Functions
 ^^^^^^^^^
 .. cfunction:: int PyContext_Check (PyObject *obj)
 .. ctype:: PyBuffers
 .. ctype:: PyBuffers_Type
 
-.. todo::
-
-  describe
+  PyBuffer objects are used by OpenAL to buffer and provide PCM data for
+  playback, recording and manipulation.
 
 Members
 ^^^^^^^
 .. cmember:: PyObject* context
+
+  The :ctype:`PyContext` the PyBuffers was created from.
+
 .. cmember:: ALCsizei count
+
+  The amount of buffers reserved.
+
 .. cmember:: ALuint* buffers
 
+  OpenAL identifiers for the single buffers.
+
 Functions
 ^^^^^^^^^
 .. cfunction:: int PyBuffers_Check (PyObject *obj)
 .. ctype:: PySources
 .. ctype:: PySources_Type
 
-.. todo::
-
-  describe
+   Sources store locations, directions, and other attributes of an
+   object in 3D space and have a buffer associated with them for
+   playback. When the program wants to play a sound, it controls
+   execution through a source object. Sources are processed
+   independently from each other.
 
 Members
 ^^^^^^^
 .. cmember:: PyObject* context
+
+  The :ctype:`PyContext` the PySources was created from.
+
 .. cmember:: ALCsizei count
+
+  The amount of sources reserved.
+
 .. cmember:: ALuint* sources
 
+  OpenAL identifiers for the single sources.
+
 Functions
 ^^^^^^^^^
 .. cfunction:: int PySources_Check (PyObject *obj)
 .. ctype:: PyListener
 .. ctype:: PyListener_Type
 
-.. todo::
-
-  describe
+  The PyListener represents the user hearing the sounds played by OpenAL
+  in a specific :ctype:`PyContext`. Source playback is done relative to
+  the position of the PyListener in the 3D space.
 
 Members
 ^^^^^^^
 .. cmember:: PyObject* context
 
+  The :ctype:`PyContext` the PyListener belongs to.
+
 Functions
 ^^^^^^^^^
 .. cfunction:: int PyListener_Check (PyObject *obj)
 ###################################
 
 Pygame2 is a cross-platform multimedia framework for the excellent
-Python programming language. It's purpose is to make writing multimedia
+Python programming language. Its purpose is to make writing multimedia
 applications, such as games, with Python as easy as possible, while
 providing the developer a reliable and extensible programming interface.
 

doc/src/openalbase.xml

       Sources store locations, directions, and other attributes of an object in
       3D space and have a buffer associated with them for playback. When the
       program wants to play a sound, it controls execution through a source
-      object. Sources are processed independently from each other and.
+      object. Sources are processed independently from each other.
       
       Sources instances cannot be created directly, but are bound to a
       :class:`Context`. To create a Sources instance for the currently
         
         .. note::
         
-          This will only succeed, when all buffers within the :class`Buffers`
+          This will only succeed, when all buffers within the :class:`Buffers`
           instance were processed by the source. Otherwise a
           :exc:`pygame2.Error` will be raised.
       </desc>

doc/src/sdlvideo.xml

       information, typically displaying some sort of image data. The Surface is
       the central element of the :mod:`pygame2.sdl.video` module and used to
       display image information on an SDL screen window.
-      
-      .. todo::
-        
-        TODO
-      
     </desc>
     <method name="blit">
       <call>blit (srcsurface[, destrect, srcrect, blendargs]) -> Rect</call>
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.