Update Game Kit docs.
Add \since to each method.
This commit is contained in:
John Scipione
@@ -23,6 +23,8 @@
|
||||
\enum direct_buffer_state
|
||||
|
||||
Direct buffer state constants
|
||||
|
||||
\since BeOS R3
|
||||
*/
|
||||
|
||||
|
||||
@@ -30,6 +32,8 @@
|
||||
\enum direct_driver_state
|
||||
|
||||
Direct driver state constants
|
||||
|
||||
\since BeOS R3
|
||||
*/
|
||||
|
||||
|
||||
@@ -39,6 +43,8 @@
|
||||
\ingroup libbe
|
||||
|
||||
Direct butter info struct
|
||||
|
||||
\since BeOS R3
|
||||
*/
|
||||
|
||||
|
||||
@@ -55,6 +61,8 @@
|
||||
- \c B_BUFFER_RESET
|
||||
- \c B_BUFFER_RESIZED
|
||||
- \c B_CLIPPING_MODIFIED
|
||||
|
||||
\since BeOS R3
|
||||
*/
|
||||
|
||||
|
||||
@@ -65,6 +73,8 @@
|
||||
There are two possible values:
|
||||
- \c B_MODE_CHANGED The resolution or color depth has changed.
|
||||
- \c B_DRIVER_CHANGED The window was moved onto another monitor.
|
||||
|
||||
\since BeOS R3
|
||||
*/
|
||||
|
||||
|
||||
@@ -72,6 +82,8 @@
|
||||
\var direct_buffer_info::bits
|
||||
|
||||
Pointer to the frame buffer in your team's memory space.
|
||||
|
||||
\since BeOS R3
|
||||
*/
|
||||
|
||||
|
||||
@@ -80,12 +92,17 @@
|
||||
|
||||
Pointer to the frame buffer in the PCI memory space. This value is
|
||||
typically needed to control DMA.
|
||||
|
||||
\since BeOS R3
|
||||
*/
|
||||
|
||||
|
||||
/*!
|
||||
\var direct_buffer_info::bytes_per_row
|
||||
|
||||
Number of bytes used to represent a single row of pixels in the frame buffer.
|
||||
|
||||
\since BeOS R3
|
||||
*/
|
||||
|
||||
|
||||
@@ -94,6 +111,8 @@
|
||||
|
||||
Number of bits actually used to store a single pixel, including reserved,
|
||||
unused, or alpha channel bits. This value is usually a multiple of eight.
|
||||
|
||||
\since BeOS R3
|
||||
*/
|
||||
|
||||
|
||||
@@ -101,6 +120,8 @@
|
||||
\var direct_buffer_info::pixel_format
|
||||
|
||||
The format used to encode a pixel as defined by the \c color_space type.
|
||||
|
||||
\since BeOS R3
|
||||
*/
|
||||
|
||||
|
||||
@@ -108,6 +129,8 @@
|
||||
\var direct_buffer_info::layout
|
||||
|
||||
Reserved for future use.
|
||||
|
||||
\since BeOS R3
|
||||
*/
|
||||
|
||||
|
||||
@@ -115,6 +138,8 @@
|
||||
\var direct_buffer_info::orientation
|
||||
|
||||
Reserved for future use.
|
||||
|
||||
\since BeOS R3
|
||||
*/
|
||||
|
||||
|
||||
@@ -122,6 +147,8 @@
|
||||
\var direct_buffer_info::_reserved[9]
|
||||
|
||||
Reserved for future use.
|
||||
|
||||
\since BeOS R3
|
||||
*/
|
||||
|
||||
|
||||
@@ -129,6 +156,8 @@
|
||||
\var direct_buffer_info::_dd_type_
|
||||
|
||||
Reserved for future use.
|
||||
|
||||
\since BeOS R3
|
||||
*/
|
||||
|
||||
|
||||
@@ -136,6 +165,8 @@
|
||||
\var direct_buffer_info::_dd_token_
|
||||
|
||||
Reserved for future use.
|
||||
|
||||
\since BeOS R3
|
||||
*/
|
||||
|
||||
|
||||
@@ -143,6 +174,8 @@
|
||||
\var direct_buffer_info::clip_list_count
|
||||
|
||||
Number of rectangles in \c clip_list.
|
||||
|
||||
\since BeOS R3
|
||||
*/
|
||||
|
||||
|
||||
@@ -151,6 +184,8 @@
|
||||
|
||||
Rectangle that defines the full content area of the window in screen
|
||||
coordinates.
|
||||
|
||||
\since BeOS R3
|
||||
*/
|
||||
|
||||
|
||||
@@ -159,6 +194,8 @@
|
||||
|
||||
Bounding rectangle of the visible part of the content area of the window
|
||||
in screen coordinates.
|
||||
|
||||
\since BeOS R3
|
||||
*/
|
||||
|
||||
|
||||
@@ -167,6 +204,8 @@
|
||||
|
||||
List of rectangles that together define the visible region of the content
|
||||
area of the window in screen coordinates.
|
||||
|
||||
\since BeOS R3
|
||||
*/
|
||||
|
||||
|
||||
@@ -175,11 +214,13 @@
|
||||
\ingroup game
|
||||
\ingroup libbe
|
||||
\brief Provides direct access to the video card graphics frame buffer.
|
||||
|
||||
\since BeOS R3
|
||||
*/
|
||||
|
||||
|
||||
/*!
|
||||
\fn BDirectWindow::BDirectWindow(BRect frame, const char *title,
|
||||
\fn BDirectWindow::BDirectWindow(BRect frame, const char* title,
|
||||
window_type type, uint32 flags, uint32 workspace)
|
||||
\brief Creates and initializes a BDirectWindow object.
|
||||
|
||||
@@ -188,11 +229,13 @@
|
||||
\param type Window type (see BWindow).
|
||||
\param flags Window flags (see BWindow).
|
||||
\param workspace Workspace of the direct window (see BWindow).
|
||||
|
||||
\since BeOS R3
|
||||
*/
|
||||
|
||||
|
||||
/*!
|
||||
\fn BDirectWindow::BDirectWindow(BRect frame, const char *title,
|
||||
\fn BDirectWindow::BDirectWindow(BRect frame, const char* title,
|
||||
window_look look, window_feel feel, uint32 flags, uint32 workspace)
|
||||
\brief Creates and initializes a BDirectWindow object.
|
||||
|
||||
@@ -202,6 +245,8 @@
|
||||
\param feel Window feel (see BWindow).
|
||||
\param flags Window flags (see BWindow).
|
||||
\param workspace Workspace of the direct window (see BWindow).
|
||||
|
||||
\since BeOS R3
|
||||
*/
|
||||
|
||||
|
||||
@@ -221,42 +266,50 @@
|
||||
disconnect from direct access.
|
||||
|
||||
Once these steps are complete you may do your usual destructor work.
|
||||
|
||||
\since BeOS R3
|
||||
*/
|
||||
|
||||
|
||||
/*!
|
||||
\fn BArchivable* BDirectWindow::Instantiate(BMessage *data)
|
||||
\fn BArchivable* BDirectWindow::Instantiate(BMessage* data)
|
||||
\brief Instantiate window from message \a data. Not implemented.
|
||||
|
||||
\since BeOS R3
|
||||
*/
|
||||
|
||||
|
||||
/*!
|
||||
\fn status_t BDirectWindow::Archive(BMessage *data, bool deep) const
|
||||
\fn status_t BDirectWindow::Archive(BMessage* data, bool deep) const
|
||||
\brief Archive window into message \a data. Not implemented.
|
||||
|
||||
\since BeOS R3
|
||||
*/
|
||||
|
||||
|
||||
/*!
|
||||
\fn void BDirectWindow::DirectConnected(direct_buffer_info *info)
|
||||
\brief hook function called when your application learns about the state
|
||||
of the graphics display and changes occur.
|
||||
\fn void BDirectWindow::DirectConnected(direct_buffer_info* info)
|
||||
\brief Hook method called when your application learns about the state
|
||||
of the graphics display and changes occur.
|
||||
|
||||
This is the heart of BDirectWindow.
|
||||
|
||||
\param info The \c direct_buffer_info struct
|
||||
|
||||
\since BeOS R3
|
||||
*/
|
||||
|
||||
|
||||
/*!
|
||||
\fn status_t BDirectWindow::GetClippingRegion(BRegion *region,
|
||||
BPoint *origin) const
|
||||
\fn status_t BDirectWindow::GetClippingRegion(BRegion* region,
|
||||
BPoint* origin) const
|
||||
\brief Sets \a region to the current clipping region of the direct window.
|
||||
|
||||
If \a origin is not \c NULL, the \a region is offset by \a origin.
|
||||
|
||||
\warning GetClippingRegion() should only be called from within the
|
||||
DirectConnected() method. If called outside GetClippingRegion() will
|
||||
return \c B_ERROR.
|
||||
DirectConnected() method. If called outside GetClippingRegion()
|
||||
will return \c B_ERROR.
|
||||
|
||||
\param region The clipping region to fill out.
|
||||
\param origin An origin to offset the region by.
|
||||
@@ -266,6 +319,8 @@
|
||||
\retval B_BAD_VALUE \a region was NULL.
|
||||
\retval B_ERROR Window not locked or not in DirectConnected() method.
|
||||
\retval B_NO_MEMORY Not enough memory to fill \a region
|
||||
|
||||
\since BeOS R3
|
||||
*/
|
||||
|
||||
|
||||
@@ -284,9 +339,11 @@
|
||||
\returns A status code.
|
||||
\retval B_OK Everything went as expected.
|
||||
\retval B_ERROR An error occurred while trying to switch between full screen
|
||||
and windowed mode.
|
||||
and windowed mode.
|
||||
|
||||
\see BDirectWindow::SupportsWindowMode()
|
||||
|
||||
\since BeOS R3
|
||||
*/
|
||||
|
||||
|
||||
@@ -295,6 +352,8 @@
|
||||
\brief Returns whether the window is in full-screen or windowed mode.
|
||||
|
||||
\returns \c true if in full-screen mode, \c false if in windowed mode.
|
||||
|
||||
\since BeOS R3
|
||||
*/
|
||||
|
||||
|
||||
@@ -306,7 +365,9 @@
|
||||
BDirectWindow object to call it.
|
||||
|
||||
\param id The id of the screen you want to check, \c B_MAIN_SCREEN_ID by
|
||||
default.
|
||||
default.
|
||||
|
||||
\returns \c true if the screen support windowed mode, \c false otherwise.
|
||||
|
||||
\since BeOS R3
|
||||
*/
|
||||
|
||||
Reference in New Issue
Block a user