Browse Source

Doc: crosslinking 1D/2D/3D alternatives.

pull/279/head
Vladimír Vondruš 14 years ago
parent
commit
b68a168fcb
  1. 2
      src/BufferedImage.h
  2. 1
      src/Image.h
  3. 1
      src/Math/Point2D.h
  4. 1
      src/Math/Point3D.h
  5. 12
      src/SceneGraph/Camera.h
  6. 20
      src/SceneGraph/Object.h
  7. 6
      src/SceneGraph/Scene.h
  8. 2
      src/Texture.h
  9. 1
      src/Trade/MeshData2D.h
  10. 1
      src/Trade/MeshData3D.h
  11. 1
      src/Trade/MeshObjectData2D.h
  12. 1
      src/Trade/MeshObjectData3D.h
  13. 1
      src/Trade/ObjectData2D.h
  14. 1
      src/Trade/ObjectData3D.h

2
src/BufferedImage.h

@ -31,7 +31,7 @@ namespace Magnum {
Class for storing image data in GPU memory. Can be replaced with Image, which Class for storing image data in GPU memory. Can be replaced with Image, which
stores image data in client memory, ImageWrapper, or for example with stores image data in client memory, ImageWrapper, or for example with
Trade::ImageData. Trade::ImageData.
@see Buffer @see BufferedImage1D, BufferedImage2D, BufferedImage3D, Buffer
@requires_gles30 (no extension providing this functionality) @requires_gles30 (no extension providing this functionality)
*/ */
template<size_t imageDimensions> class BufferedImage: public AbstractImage { template<size_t imageDimensions> class BufferedImage: public AbstractImage {

1
src/Image.h

@ -30,6 +30,7 @@ namespace Magnum {
Class for storing image data on client memory. Can be replaced with Class for storing image data on client memory. Can be replaced with
ImageWrapper, BufferedImage, which stores image data in GPU memory, or for ImageWrapper, BufferedImage, which stores image data in GPU memory, or for
example with Trade::ImageData. example with Trade::ImageData.
@see Image1D, Image2D, Image3D
*/ */
template<size_t imageDimensions> class Image: public AbstractImage { template<size_t imageDimensions> class Image: public AbstractImage {
public: public:

1
src/Math/Point2D.h

@ -29,6 +29,7 @@ namespace Magnum { namespace Math {
Same as Vector3, except that constructors have default value for Z component Same as Vector3, except that constructors have default value for Z component
set to one. See also @ref matrix-vector for brief introduction. set to one. See also @ref matrix-vector for brief introduction.
@see Point3D
@configurationvalueref{Magnum::Math::Point2D} @configurationvalueref{Magnum::Math::Point2D}
*/ */
template<class T> class Point2D: public Vector3<T> { template<class T> class Point2D: public Vector3<T> {

1
src/Math/Point3D.h

@ -29,6 +29,7 @@ namespace Magnum { namespace Math {
Same as Vector4, except that constructors have default value for W component Same as Vector4, except that constructors have default value for W component
set to one. See also @ref matrix-vector for brief introduction. set to one. See also @ref matrix-vector for brief introduction.
@see Point2D
@configurationvalueref{Magnum::Math::Point3D} @configurationvalueref{Magnum::Math::Point3D}
*/ */
template<class T> class Point3D: public Vector4<T> { template<class T> class Point3D: public Vector4<T> {

12
src/SceneGraph/Camera.h

@ -183,7 +183,11 @@ namespace Implementation {
} }
#endif #endif
/** @brief %Camera for two-dimensional scenes */ /**
@brief %Camera for two-dimensional scenes
@see Camera3D
*/
class SCENEGRAPH_EXPORT Camera2D: public AbstractCamera<2> { class SCENEGRAPH_EXPORT Camera2D: public AbstractCamera<2> {
public: public:
/** /**
@ -206,7 +210,11 @@ class SCENEGRAPH_EXPORT Camera2D: public AbstractCamera<2> {
Camera2D* setProjection(const Vector2& size); Camera2D* setProjection(const Vector2& size);
}; };
/** @brief %Camera for three-dimensional scenes */ /**
@brief %Camera for three-dimensional scenes
@see Camera2D
*/
class SCENEGRAPH_EXPORT Camera3D: public AbstractCamera<3> { class SCENEGRAPH_EXPORT Camera3D: public AbstractCamera<3> {
public: public:
/** /**

20
src/SceneGraph/Object.h

@ -71,10 +71,10 @@ namespace Implementation {
*/ */
/** /**
* @brief Base for all positioned objects @brief Base for all positioned objects
*
* @todo Transform transformation when changing parent, so the object stays in @todo Transform transformation when changing parent, so the object stays in
* place. place.
*/ */
template<size_t dimensions> class SCENEGRAPH_EXPORT AbstractObject: public Corrade::Containers::LinkedList<typename Implementation::ObjectDimensionTraits<dimensions>::ObjectType>, public Corrade::Containers::LinkedListItem<typename Implementation::ObjectDimensionTraits<dimensions>::ObjectType, typename Implementation::ObjectDimensionTraits<dimensions>::ObjectType> { template<size_t dimensions> class SCENEGRAPH_EXPORT AbstractObject: public Corrade::Containers::LinkedList<typename Implementation::ObjectDimensionTraits<dimensions>::ObjectType>, public Corrade::Containers::LinkedListItem<typename Implementation::ObjectDimensionTraits<dimensions>::ObjectType, typename Implementation::ObjectDimensionTraits<dimensions>::ObjectType> {
#ifndef DOXYGEN_GENERATING_OUTPUT #ifndef DOXYGEN_GENERATING_OUTPUT
@ -328,7 +328,11 @@ extern template class SCENEGRAPH_EXPORT AbstractObject<2>;
extern template class SCENEGRAPH_EXPORT AbstractObject<3>; extern template class SCENEGRAPH_EXPORT AbstractObject<3>;
#endif #endif
/** @brief Two-dimensional object */ /**
@brief Two-dimensional object
@see Object3D
*/
class SCENEGRAPH_EXPORT Object2D: public AbstractObject<2> { class SCENEGRAPH_EXPORT Object2D: public AbstractObject<2> {
public: public:
/** @copydoc AbstractObject::AbstractObject() */ /** @copydoc AbstractObject::AbstractObject() */
@ -379,7 +383,11 @@ class SCENEGRAPH_EXPORT Object2D: public AbstractObject<2> {
} }
}; };
/** @brief Three-dimensional object */ /**
@brief Three-dimensional object
@see Object2D
*/
class SCENEGRAPH_EXPORT Object3D: public AbstractObject<3> { class SCENEGRAPH_EXPORT Object3D: public AbstractObject<3> {
public: public:
/** @copydoc AbstractObject::AbstractObject() */ /** @copydoc AbstractObject::AbstractObject() */

6
src/SceneGraph/Scene.h

@ -23,7 +23,11 @@
namespace Magnum { namespace SceneGraph { namespace Magnum { namespace SceneGraph {
/** @brief %Scene */ /**
@brief %Scene
@see Scene2D, Scene3D
*/
template<size_t dimensions> class SCENEGRAPH_EXPORT Scene: public AbstractObject<dimensions>::ObjectType { template<size_t dimensions> class SCENEGRAPH_EXPORT Scene: public AbstractObject<dimensions>::ObjectType {
public: public:
/** @copydoc AbstractObject::isScene() */ /** @copydoc AbstractObject::isScene() */

2
src/Texture.h

@ -46,7 +46,7 @@ for more information.
@requires_gl (rectangle textures) @requires_gl (rectangle textures)
@requires_gl31 Extension @extension{ARB,texture_rectangle} (rectangle textures) @requires_gl31 Extension @extension{ARB,texture_rectangle} (rectangle textures)
@see CubeMapTexture, CubeMapTextureArray @see Texture1D, Texture2D, Texture3D, CubeMapTexture, CubeMapTextureArray
*/ */
template<size_t textureDimensions> class Texture: public AbstractTexture { template<size_t textureDimensions> class Texture: public AbstractTexture {
public: public:

1
src/Trade/MeshData2D.h

@ -31,6 +31,7 @@ namespace Magnum { namespace Trade {
Provides access to mesh data and additional information, such as primitive Provides access to mesh data and additional information, such as primitive
type. type.
@see MeshData3D
*/ */
class MAGNUM_EXPORT MeshData2D { class MAGNUM_EXPORT MeshData2D {
MeshData2D(const MeshData2D& other) = delete; MeshData2D(const MeshData2D& other) = delete;

1
src/Trade/MeshData3D.h

@ -31,6 +31,7 @@ namespace Magnum { namespace Trade {
Provides access to mesh data and additional information, such as primitive Provides access to mesh data and additional information, such as primitive
type. type.
@see MeshData2D
*/ */
class MAGNUM_EXPORT MeshData3D { class MAGNUM_EXPORT MeshData3D {
MeshData3D(const MeshData3D& other) = delete; MeshData3D(const MeshData3D& other) = delete;

1
src/Trade/MeshObjectData2D.h

@ -27,6 +27,7 @@ namespace Magnum { namespace Trade {
@brief Two-dimensional mesh object data @brief Two-dimensional mesh object data
Provides access to material information for given mesh instance. Provides access to material information for given mesh instance.
@see MeshObjectData3D
*/ */
class MeshObjectData2D: public ObjectData2D { class MeshObjectData2D: public ObjectData2D {
MeshObjectData2D(const MeshObjectData2D& other) = delete; MeshObjectData2D(const MeshObjectData2D& other) = delete;

1
src/Trade/MeshObjectData3D.h

@ -27,6 +27,7 @@ namespace Magnum { namespace Trade {
@brief Three-dimensional mesh object data @brief Three-dimensional mesh object data
Provides access to material information for given mesh instance. Provides access to material information for given mesh instance.
@see MeshObjectData2D
*/ */
class MeshObjectData3D: public ObjectData3D { class MeshObjectData3D: public ObjectData3D {
MeshObjectData3D(const MeshObjectData3D& other) = delete; MeshObjectData3D(const MeshObjectData3D& other) = delete;

1
src/Trade/ObjectData2D.h

@ -29,6 +29,7 @@ namespace Magnum { namespace Trade {
Provides access to object transformation and hierarchy. See also Provides access to object transformation and hierarchy. See also
MeshObjectData2D, which is specialized for objects with mesh instance type. MeshObjectData2D, which is specialized for objects with mesh instance type.
@see ObjectData3D
*/ */
class ObjectData2D { class ObjectData2D {
ObjectData2D(const ObjectData2D& other) = delete; ObjectData2D(const ObjectData2D& other) = delete;

1
src/Trade/ObjectData3D.h

@ -29,6 +29,7 @@ namespace Magnum { namespace Trade {
Provides access to object transformation and hierarchy. See also Provides access to object transformation and hierarchy. See also
MeshObjectData3D, which is specialized for objects with mesh instance type. MeshObjectData3D, which is specialized for objects with mesh instance type.
@see ObjectData2D
*/ */
class ObjectData3D { class ObjectData3D {
ObjectData3D(const ObjectData3D& other) = delete; ObjectData3D(const ObjectData3D& other) = delete;

Loading…
Cancel
Save