*/
enum ViewMode
{
- MONO, ///< Monoscopic (single camera). This is the default @SINCE_1_0.0
- STEREO_HORIZONTAL, ///< @DEPRECATED_1_3_39 Stereoscopic. Frame buffer is split horizontally with the left and right camera views in their respective sides. @SINCE_1_0.0
- STEREO_VERTICAL ///< @DEPRECATED_1_3_39 Stereoscopic. Frame buffer is split vertically with the left camera view at the top and the right camera view at the bottom. @SINCE_1_0.0
+ MONO, ///< Monoscopic (single camera). This is the default. @SINCE_1_0.0
+ STEREO_HORIZONTAL, ///< @DEPRECATED_1_3_39 Stereoscopic. This mode presents the left image on the top half of the screen and the right image on the bottom half. @SINCE_1_0.0
+ STEREO_VERTICAL ///< @DEPRECATED_1_3_39 Stereoscopic. This mode renders the left image on the left half of the screen and the right image on the right half. @SINCE_1_0.0
};
/**
Degree GetAngle( std::size_t point ) const;
/**
- * @brief Get the device class type the mouse/touch event originated from.
+ * @brief Gets the device class type from which the mouse/touch event is originated.
*
* The device class type is classification type of the input device of event received.
* @SINCE_1_2.60
Device::Class::Type GetDeviceClass( std::size_t point ) const;
/**
- * @brief Get the device subclass type the mouse/touch event originated from.
+ * @brief Gets the subclass type of the device from which the mouse/touch event is originated.
*
* The device subclass type is subclassification type of the input device of event received.
* @SINCE_1_2.60
/**
- * @brief Get mouse device's button value (ex: right/left button)
+ * @brief Gets the value, which indicates a mouse button. (ex: right/left button)
*
* @SINCE_1_3_31
* @param[in] point The point required
*/
enum Mask
{
- NONE = 0, ///< No attachments are created initially @SINCE_1_1.45
- DEPTH = 1 << 0, ///< Depth buffer is created @SINCE_1_1.45
- STENCIL = 1 << 1, ///< Stencil buffer is created @SINCE_1_1.45
- DEPTH_STENCIL = DEPTH | STENCIL, ///< Depth and stencil buffer will be created @SINCE_1_1.45
- COLOR = 1 << 2, ///< Color texture will be created @SINCE_1_4.0
- COLOR_DEPTH = COLOR | DEPTH, ///< Color texture and depth buffer will be created @SINCE_1_4.0
- COLOR_STENCIL = COLOR | STENCIL, ///< Color texture and stencil buffer will be created @SINCE_1_4.0
- COLOR_DEPTH_STENCIL = COLOR_DEPTH | STENCIL ///< Color, depth and stencil buffer will be created @SINCE_1_4.0
+ NONE = 0, ///< No attachments are created initially. @SINCE_1_1.45
+ DEPTH = 1 << 0, ///< Depth buffer is created. @SINCE_1_1.45
+ STENCIL = 1 << 1, ///< Stencil buffer is created. @SINCE_1_1.45
+ DEPTH_STENCIL = DEPTH | STENCIL, ///< Depth and stencil buffer are created. @SINCE_1_1.45
+ COLOR = 1 << 2, ///< Color texture is created. @SINCE_1_4.0
+ COLOR_DEPTH = COLOR | DEPTH, ///< Color texture and depth buffer are created. @SINCE_1_4.0
+ COLOR_STENCIL = COLOR | STENCIL, ///< Color texture and stencil buffer are created. @SINCE_1_4.0
+ COLOR_DEPTH_STENCIL = COLOR_DEPTH | STENCIL ///< Color, depth and stencil buffer are created. @SINCE_1_4.0
};
};
/**
- * @brief Creates a new FrameBuffer with only COLOR texture attached on it
+ * @brief Creates a new FrameBuffer, which attaches only COLOR texture.
*
* @SINCE_1_4.0
*
static FrameBuffer New( uint32_t width, uint32_t height );
/**
- * @brief Creates a new FrameBuffer with the specified attachments
+ * @brief Creates a new FrameBuffer with specific attachments.
*
* @SINCE_1_4.0
*