Skip to content

Commit 2298eb2

Browse files
committed
renderer: Update docstring format for texture.h.
1 parent e675d84 commit 2298eb2

File tree

1 file changed

+30
-10
lines changed

1 file changed

+30
-10
lines changed

libopenage/renderer/texture.h

Lines changed: 30 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
// Copyright 2015-2024 the openage authors. See copying.md for legal info.
1+
// Copyright 2015-2025 the openage authors. See copying.md for legal info.
22

33
#pragma once
44

@@ -8,28 +8,48 @@
88
namespace openage {
99
namespace renderer {
1010

11-
/// An abstract base for a handle to a texture buffer allocated in graphics hardware.
12-
/// Can be obtained by passing texture data to the renderer.
11+
/**
12+
* An abstract base for a handle to a texture buffer allocated in graphics hardware.
13+
* Can be obtained by passing texture data to the renderer.
14+
*/
1315
class Texture2d {
1416
public:
1517
virtual ~Texture2d();
1618

17-
/// Returns the texture information.
19+
/**
20+
* Get the texture information.
21+
*
22+
* @return Information about the texture, such as size and format.
23+
*/
1824
const resources::Texture2dInfo &get_info() const;
1925

20-
/// Copies this texture's data from graphics hardware into a CPU-accessible
21-
/// Texture2dData buffer.
26+
/**
27+
* Copies this texture's data from graphics hardware into a CPU-accessible
28+
* Texture2dData buffer.
29+
*
30+
* @return A Texture2dData object containing the texture data.
31+
*/
2232
virtual resources::Texture2dData into_data() = 0;
2333

24-
/// Uploads the provided data into the GPU texture storage. The format has
25-
/// to match the format this Texture was originally created with.
34+
/**
35+
* Uploads the provided data into the GPU texture storage. The format has
36+
* to match the format this Texture was originally created with.
37+
*
38+
* @param data The texture data to upload.
39+
*/
2640
virtual void upload(resources::Texture2dData const &) = 0;
2741

2842
protected:
29-
/// Constructs the base with the given information.
43+
/**
44+
* Constructs the base with the given information.
45+
*
46+
* @param info Information about the texture, such as size and format.
47+
*/
3048
Texture2d(const resources::Texture2dInfo &);
3149

32-
/// Information about the size, format, etc. of this texture.
50+
/**
51+
* Information about the size, format, etc. of this texture.
52+
*/
3353
resources::Texture2dInfo info;
3454
};
3555

0 commit comments

Comments
 (0)