File: cdrom.rst.txt

package info (click to toggle)
pygame 2.1.2%2Bdfsg-5
  • links: PTS, VCS
  • area: main
  • in suites: bookworm
  • size: 32,416 kB
  • sloc: ansic: 66,042; python: 46,176; javascript: 9,214; objc: 273; sh: 78; makefile: 56; cpp: 25
file content (41 lines) | stat: -rw-r--r-- 1,098 bytes parent folder | download | duplicates (2)
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
35
36
37
38
39
40
41
.. include:: ../common.txt

.. highlight:: c

********************************
  API exported by pygame.cdrom
********************************

src_c/cdrom.c
=============

The :py:mod:`pygame.cdrom` extension module. Only available for SDL 1.

Header file: src_c/include/pygame.h


.. c:type:: pgCDObject

   The :py:class:`pygame.cdrom.CD` instance C struct.

.. c:var:: PyTypeObject pgCD_Type

   The :py:class:`pygame.cdrom.CD` Python type.

.. c:function:: PyObject* pgCD_New(int id)

   Return a new :py:class:`pygame.cdrom.CD` instance for CD drive *id*.
   On error raise a Python exception and return ``NULL``.

.. c:function:: int pgCD_Check(PyObject *x)

   Return true if *x* is a :py:class:`pygame.cdrom.CD` instance.
   Will return false for a subclass of :py:class:`CD`.
   This is a macro. No check is made that *x* is not ``NULL``.

.. c:function:: int pgCD_AsID(PyObject *x)

   Return the CD identifier associated with the :py:class:`pygame.cdrom.CD`
   instance *x*.
   This is a macro. No check is made that *x* is a :py:class:`pygame.cdrom.CD`
   instance or is not ``NULL``.