Chromium Code Reviews
chromiumcodereview-hr@appspot.gserviceaccount.com (chromiumcodereview-hr) | Please choose your nickname with Settings | Help | Chromium Project | Gerrit Changes | Sign out
(141)

Side by Side Diff: ppapi/c/pp_point.h

Issue 6312098: Updating documentation (Closed) Base URL: svn://svn.chromium.org/chrome/trunk/src/
Patch Set: '' Created 9 years, 10 months ago
Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.
Jump to:
View unified diff | Download patch | Annotate | Revision Log
OLDNEW
1 /* Copyright (c) 2010 The Chromium Authors. All rights reserved. 1 /* Copyright (c) 2010 The Chromium Authors. All rights reserved.
2 * Use of this source code is governed by a BSD-style license that can be 2 * Use of this source code is governed by a BSD-style license that can be
3 * found in the LICENSE file. 3 * found in the LICENSE file.
4 */ 4 */
5 #ifndef PPAPI_C_PP_POINT_H_ 5 #ifndef PPAPI_C_PP_POINT_H_
6 #define PPAPI_C_PP_POINT_H_ 6 #define PPAPI_C_PP_POINT_H_
7 7
8 /** 8 /**
9 * @file 9 * @file
10 * Defines the API ... 10 * This file defines the APIs to create a 2 dimensional point on the screen.
dmichael(do not use this one) 2011/02/02 23:36:51 s/APIs/API s/create/represent s/on the screen/in t
jond 2011/02/03 17:28:11 Done.
11 * 0,0 is the upper-left corner of the screen.
dmichael(do not use this one) 2011/02/02 23:36:51 s/screen/drawing window (???)
jond 2011/02/03 17:28:11 Done.
11 */ 12 */
12 13
13 #include "ppapi/c/pp_macros.h" 14 #include "ppapi/c/pp_macros.h"
14 #include "ppapi/c/pp_stdint.h" 15 #include "ppapi/c/pp_stdint.h"
15 16
16 /** 17 /**
17 * 18 *
18 * @addtogroup Structs 19 * @addtogroup Structs
19 * @{ 20 * @{
20 */ 21 */
22
23 /**
24 * The PP_Point structure defines the x and y coordinates of a point on the
25 * screen.
26 */
dmichael(do not use this one) 2011/02/02 23:36:51 Not 'on the screen'
jond 2011/02/03 17:28:11 Done.
21 struct PP_Point { 27 struct PP_Point {
28 /** This value represents the horizontal coordinate of a point on the
29 * screen.
dmichael(do not use this one) 2011/02/02 23:36:51 not 'on the screen', counting from 0 on the left.
jond 2011/02/03 17:28:11 Done.
30 */
22 int32_t x; 31 int32_t x;
32
33 /* This value represents the vertical coordinate of a point on the screen. */
dmichael(do not use this one) 2011/02/02 23:36:51 not 'on the screen', counting from 0 at the top.
jond 2011/02/03 17:28:11 Done.
23 int32_t y; 34 int32_t y;
24 }; 35 };
25 PP_COMPILE_ASSERT_STRUCT_SIZE_IN_BYTES(PP_Point, 8); 36 PP_COMPILE_ASSERT_STRUCT_SIZE_IN_BYTES(PP_Point, 8);
26 /** 37 /**
27 * @} 38 * @}
28 */ 39 */
29 40
30 /** 41 /**
31 * @addtogroup Functions 42 * @addtogroup Functions
32 * @{ 43 * @{
33 */ 44 */
45
46 /**
47 * PP_MakePoint() places two 32 bit integers inside a PP_Point structure.
dmichael(do not use this one) 2011/02/02 23:36:51 I'd rather wording like: 'creates a PP_Point given
jond 2011/02/03 17:28:11 Done.
jond 2011/02/03 17:28:11 Done.
48 * @param[in] x A 32 bit value representing a horizontal coordinate on the
49 * screen.
50 * @param[in] y A 32 bit value representing a vertical coordinate on the
51 * screen.
52 * @return A PP_Point structure.
53 */
34 PP_INLINE struct PP_Point PP_MakePoint(int32_t x, int32_t y) { 54 PP_INLINE struct PP_Point PP_MakePoint(int32_t x, int32_t y) {
35 struct PP_Point ret; 55 struct PP_Point ret;
36 ret.x = x; 56 ret.x = x;
37 ret.y = y; 57 ret.y = y;
38 return ret; 58 return ret;
39 } 59 }
40 /** 60 /**
41 * @} 61 * @}
42 */ 62 */
43 63
44 #endif /* PPAPI_C_PP_POINT_H_ */ 64 #endif /* PPAPI_C_PP_POINT_H_ */
45 65
OLDNEW

Powered by Google App Engine
This is Rietveld 408576698