Fill out the BView docs

* Fill out the Input related method descriptions and also some other updates
  to method and variable descriptions.
* Document Graphics State Methods and a bunch of Drawing Related Methods
* Add a bunch more drawing method descriptions.
* Fill out the rest of the methods of the BView class.
This commit is contained in:
John Scipione 2013-06-03 20:12:40 -04:00
parent 77ea49f4f2
commit 2891821fde
3 changed files with 3227 additions and 51 deletions

View File

@ -0,0 +1,93 @@
/*
* Copyright 2013 Haiku, Inc. All rights reserved.
* Distributed under the terms of the MIT License.
*
* Authors:
* John Scipione, jscipione@gmail.com
*
* Corresponds to:
* headers/os/interface/GraphicsDefs.h hrev45737
* src/kits/interface/GraphicsDefs.cpp hrev45737
*/
/*!
\file GraphicsDefs.h
\ingroup interface
\ingroup libbe
\brief Graphics-related functions and variables used by the Interface Kit.
*/
/*!
\struct pattern
\ingroup interface
\ingroup libbe
\brief A pattern to use when drawing.
*/
/*!
\var B_SOLID_HIGH
Draw using the view's high color.
*/
/*!
\var B_MIXED_COLORS
Draw a pattern of the view's high and low colors.
*/
/*!
\var B_SOLID_LOW
Draw using the view's low color.
*/
/*!
\enum source_alpha
\ingroup interface
Blending alpha mode constants.
*/
/*!
\var source_alpha B_PIXEL_ALPHA
Use the alpha value of each pixel when drawing a bitmap.
*/
/*!
\var source_alpha B_CONSTANT_ALPHA
Use the alpha channel of the view's high color.
*/
/*!
\enum alpha_function
\ingroup interface
Blending alpha function constants.
*/
/*!
\var alpha_function B_ALPHA_OVERLAY
Used for drawing a image with transparency over an opaque background.
*/
/*!
\var alpha_function B_ALPHA_COMPOSITE
Used to composite two or more transparent images together offscreen to
produce a new image drawn using \c B_ALPHA_OVERLAY mode.
*/

View File

@ -1,13 +1,13 @@
/* /*
* Copyright 2011 Haiku, Inc. All rights reserved. * Copyright 2011-2013 Haiku, Inc. All rights reserved.
* Distributed under the terms of the MIT License. * Distributed under the terms of the MIT License.
* *
* Authors: * Authors:
* John Scipione, jscipione@gmail.com * John Scipione, jscipione@gmail.com
* *
* Corresponds to: * Corresponds to:
* headers/os/interface/InterfaceDefs.h rev 43230 * headers/os/interface/InterfaceDefs.h hrev45737
* src/kits/interface/InterfaceDefs.cpp rev 43230 * src/kits/interface/InterfaceDefs.cpp hrev45737
*/ */
@ -107,6 +107,85 @@
*/ */
// Line join and cap modes
/*!
\enum join_mode
PostScript-style line join modes used by BView::SetLineMode()
*/
/*!
\var join_mode B_ROUND_JOIN
Round join mode.
*/
/*!
\var join_mode B_MITER_JOIN
Miter join mode.
*/
/*!
\var join_mode B_BEVEL_JOIN
Bevel join mode.
*/
/*!
\var join_mode B_BUTT_JOIN
Butt join mode.
*/
/*!
\var join_mode B_SQUARE_JOIN
Square join mode.
*/
/*!
\enum cap_mode
PostScript-style line cap modes used by BView::SetLineMode()
*/
/*!
\var cap_mode B_ROUND_CAP
Round cap mode.
*/
/*!
\var cap_mode B_BUTT_CAP
Butt cap mode.
*/
/*!
\var cap_mode B_SQUARE_CAP
Square cap mode.
*/
/*!
\var B_DEFAULT_MITER_LIMIT
Default miter limit used to calculate the angle cut off for miter joins.
*/
///// Keyboard related functions ///// Keyboard related functions

File diff suppressed because it is too large Load Diff