blob: b83e3cdb5a1a80687fcdb8860159a6e8358adad2 [file] [log] [blame]
/* Copyright (c) 2012 The Chromium Authors. All rights reserved.
* Use of this source code is governed by a BSD-style license that can be
* found in the LICENSE file.
*/
/**
* This file defines the APIs for creating a 2 dimensional rectangle.
*/
/**
* The <code>PP_Rect</code> struct contains the size and location of a 2D
* rectangle.
*/
[assert_size(16)]
struct PP_Rect {
/**
* This value represents the x and y coordinates of the upper-left corner of
* the rectangle.
*/
PP_Point point;
/** This value represents the width and height of the rectangle. */
PP_Size size;
};
/**
* The <code>PP_FloatRect</code> struct contains the size and location of a 2D
* rectangle.
*/
struct PP_FloatRect {
/**
* This value represents the x and y coordinates of the upper-left corner of
* the rectangle.
*/
PP_FloatPoint point;
/** This value represents the width and height of the rectangle. */
PP_FloatSize size;
};
#inline c
/**
* @addtogroup Functions
* @{
*/
/**
* PP_MakeRectFromXYWH() creates a <code>PP_Rect</code> given x and y
* coordinates and width and height dimensions as int32_t values.
*
* @param[in] x An int32_t value representing a horizontal coordinate of a
* point, starting with 0 as the left-most coordinate.
* @param[in] y An int32_t value representing a vertical coordinate of a point,
* starting with 0 as the top-most coordinate.
* @param[in] w An int32_t value representing a width.
* @param[in] h An int32_t value representing a height.
*
* @return A <code>PP_Rect</code> structure.
*/
PP_INLINE struct PP_Rect PP_MakeRectFromXYWH(int32_t x, int32_t y,
int32_t w, int32_t h) {
struct PP_Rect ret;
ret.point.x = x;
ret.point.y = y;
ret.size.width = w;
ret.size.height = h;
return ret;
}
/**
* PP_MakeFloatRectFromXYWH() creates a <code>PP_FloatRect</code> given x and y
* coordinates and width and height dimensions as float values.
*
* @param[in] x An float value representing a horizontal coordinate of a
* point, starting with 0 as the left-most coordinate.
* @param[in] y An float value representing a vertical coordinate of a point,
* starting with 0 as the top-most coordinate.
* @param[in] w An float value representing a width.
* @param[in] h An float value representing a height.
*
* @return A <code>PP_FloatRect</code> structure.
*/
PP_INLINE struct PP_FloatRect PP_MakeFloatRectFromXYWH(float x, float y,
float w, float h) {
struct PP_FloatRect ret;
ret.point.x = x;
ret.point.y = y;
ret.size.width = w;
ret.size.height = h;
return ret;
}
/**
* @}
*/
#endinl