mirror of
https://github.com/panda3d/panda3d.git
synced 2025-09-29 00:06:44 -04:00
general: Fix a couple of misformatted docstrings.
This commit is contained in:
parent
c52db7239b
commit
3bfd994cf8
@ -42,17 +42,23 @@ PUBLISHED:
|
|||||||
virtual void set_loop_count(unsigned long loop_count=1) = 0;
|
virtual void set_loop_count(unsigned long loop_count=1) = 0;
|
||||||
virtual unsigned long get_loop_count() const = 0;
|
virtual unsigned long get_loop_count() const = 0;
|
||||||
|
|
||||||
/*
|
/**
|
||||||
* Control time position within the sound. This is similar (in concept) to
|
* Control time position within the sound, in seconds. This is similar (in
|
||||||
* the seek position within a file. time in seconds: 0 = beginning; length()
|
* concept) to the seek position within a file. The value starts at 0.0 (the
|
||||||
* = end. inits to 0.0. - The current time position will not change while the
|
* default) and ends at the value given by the length() method.
|
||||||
* sound is playing; you must call play() again to effect the change. To play
|
*
|
||||||
* the same sound from a time offset a second time, explicitly set the time
|
* The current time position will not change while the sound is playing; you
|
||||||
* position again. When looping, the second and later loops will start from
|
* must call play() again to effect the change. To play the same sound from
|
||||||
* the beginning of the sound. - If a sound is playing, calling get_time()
|
* a time offset a second time, explicitly set the time position again. When
|
||||||
* repeatedly will return different results over time. e.g.: PN_stdfloat
|
* looping, the second and later loops will start from the beginning of the
|
||||||
* percent_complete = s.get_time() s.length();
|
* sound.
|
||||||
*/
|
*
|
||||||
|
* If a sound is playing, calling get_time() repeatedly will return different
|
||||||
|
* results over time. e.g.
|
||||||
|
* @code
|
||||||
|
* PN_stdfloat percent_complete = s.get_time() / s.length();
|
||||||
|
* @endcode
|
||||||
|
*/
|
||||||
virtual void set_time(PN_stdfloat start_time=0.0) = 0;
|
virtual void set_time(PN_stdfloat start_time=0.0) = 0;
|
||||||
virtual PN_stdfloat get_time() const = 0;
|
virtual PN_stdfloat get_time() const = 0;
|
||||||
|
|
||||||
|
@ -22,12 +22,13 @@
|
|||||||
*/
|
*/
|
||||||
class EXPCL_PANDA_PUTIL BamEnums {
|
class EXPCL_PANDA_PUTIL BamEnums {
|
||||||
PUBLISHED:
|
PUBLISHED:
|
||||||
|
/**
|
||||||
// This defines an enumerated type used to represent the endianness of
|
* This defines an enumerated type used to represent the endianness of
|
||||||
// certain numeric values stored in a Bam file. It really has only two
|
* certain numeric values stored in a Bam file. It really has only two
|
||||||
// possible values, either BE_bigendian or BE_littleendian; but through a
|
* possible values, either BE_bigendian or BE_littleendian; but through a
|
||||||
// preprocessor trick we also add BE_native, which is the same numerically
|
* preprocessor trick we also add BE_native, which is the same numerically
|
||||||
// as whichever value the hardware supports natively.
|
* as whichever value the hardware supports natively.
|
||||||
|
*/
|
||||||
enum BamEndian {
|
enum BamEndian {
|
||||||
BE_bigendian = 0,
|
BE_bigendian = 0,
|
||||||
BE_littleendian = 1,
|
BE_littleendian = 1,
|
||||||
@ -38,21 +39,25 @@ PUBLISHED:
|
|||||||
#endif
|
#endif
|
||||||
};
|
};
|
||||||
|
|
||||||
/*
|
/**
|
||||||
* This is the code written along with each object. It is used to control
|
* This is the code written along with each object. It is used to control
|
||||||
* object scoping. A BOC_push includes an object definition, and will always
|
* object scoping.
|
||||||
* be eventually paired with a BOC_pop (which does not). A BOC_adjunct
|
*/
|
||||||
* includes an object definition but does not push the level; it is associated
|
|
||||||
* with the current level. BOC_remove lists object ID's that have been
|
|
||||||
* deallocated on the sender end. BOC_file_data may appear at any level and
|
|
||||||
* indicates the following datagram contains auxiliary file data that may be
|
|
||||||
* referenced by a later object.
|
|
||||||
*/
|
|
||||||
enum BamObjectCode {
|
enum BamObjectCode {
|
||||||
|
// Indicates an object definition, and will always be eventually paired
|
||||||
|
// with a BOC_pop (which does not).
|
||||||
BOC_push,
|
BOC_push,
|
||||||
BOC_pop,
|
BOC_pop,
|
||||||
|
|
||||||
|
// Includes an object definition but does not push the level; it is
|
||||||
|
// associated with the current level.
|
||||||
BOC_adjunct,
|
BOC_adjunct,
|
||||||
|
|
||||||
|
// Lists object IDs that have been deallocated on the sender end.
|
||||||
BOC_remove,
|
BOC_remove,
|
||||||
|
|
||||||
|
// May appear at any level and indicates the following datagram contains
|
||||||
|
// auxiliary file data that may be referenced by a later object.
|
||||||
BOC_file_data,
|
BOC_file_data,
|
||||||
};
|
};
|
||||||
|
|
||||||
|
Loading…
x
Reference in New Issue
Block a user