diff options
author | Campbell Barton <ideasman42@gmail.com> | 2020-09-12 09:33:34 +0300 |
---|---|---|
committer | Campbell Barton <ideasman42@gmail.com> | 2020-09-12 09:33:34 +0300 |
commit | 8c1726918374e1d2d2123e17bae8db5aadde3433 (patch) | |
tree | bf6890c679d5eec336af5bc2424c8580934c0613 /source/blender/imbuf | |
parent | 4c24e8e992c78d812cdfcb90e3aa648714597ae1 (diff) |
Cleanup: use C style doxygen comments
Diffstat (limited to 'source/blender/imbuf')
-rw-r--r-- | source/blender/imbuf/intern/dds/BlockDXT.cpp | 32 | ||||
-rw-r--r-- | source/blender/imbuf/intern/dds/BlockDXT.h | 18 | ||||
-rw-r--r-- | source/blender/imbuf/intern/dds/Color.h | 4 | ||||
-rw-r--r-- | source/blender/imbuf/intern/dds/ColorBlock.cpp | 34 | ||||
-rw-r--r-- | source/blender/imbuf/intern/dds/ColorBlock.h | 12 | ||||
-rw-r--r-- | source/blender/imbuf/intern/dds/DirectDrawSurface.h | 6 | ||||
-rw-r--r-- | source/blender/imbuf/intern/dds/Image.h | 2 |
7 files changed, 54 insertions, 54 deletions
diff --git a/source/blender/imbuf/intern/dds/BlockDXT.cpp b/source/blender/imbuf/intern/dds/BlockDXT.cpp index 1fbe7b46963..8978b823e2a 100644 --- a/source/blender/imbuf/intern/dds/BlockDXT.cpp +++ b/source/blender/imbuf/intern/dds/BlockDXT.cpp @@ -247,14 +247,14 @@ void BlockDXT1::setIndices(const int *idx) } } -/// Flip DXT1 block vertically. +/** Flip DXT1 block vertically. */ inline void BlockDXT1::flip4() { swap(row[0], row[3]); swap(row[1], row[2]); } -/// Flip half DXT1 block vertically. +/** Flip half DXT1 block vertically. */ inline void BlockDXT1::flip2() { swap(row[0], row[1]); @@ -299,27 +299,27 @@ void AlphaBlockDXT3::decodeBlock(ColorBlock *block) const block->color(0xF).a = (alphaF << 4) | alphaF; } -/// Flip DXT3 alpha block vertically. +/** Flip DXT3 alpha block vertically. */ void AlphaBlockDXT3::flip4() { swap(row[0], row[3]); swap(row[1], row[2]); } -/// Flip half DXT3 alpha block vertically. +/** Flip half DXT3 alpha block vertically. */ void AlphaBlockDXT3::flip2() { swap(row[0], row[1]); } -/// Flip DXT3 block vertically. +/** Flip DXT3 block vertically. */ void BlockDXT3::flip4() { alpha.flip4(); color.flip4(); } -/// Flip half DXT3 block vertically. +/** Flip half DXT3 block vertically. */ void BlockDXT3::flip2() { alpha.flip2(); @@ -458,21 +458,21 @@ void BlockDXT5::decodeBlockNV5x(ColorBlock *block) const alpha.decodeBlock(block); } -/// Flip DXT5 block vertically. +/** Flip DXT5 block vertically. */ void BlockDXT5::flip4() { alpha.flip4(); color.flip4(); } -/// Flip half DXT5 block vertically. +/** Flip half DXT5 block vertically. */ void BlockDXT5::flip2() { alpha.flip2(); color.flip2(); } -/// Decode ATI1 block. +/** Decode ATI1 block. */ void BlockATI1::decodeBlock(ColorBlock *block) const { uint8 alpha_array[8]; @@ -488,19 +488,19 @@ void BlockATI1::decodeBlock(ColorBlock *block) const } } -/// Flip ATI1 block vertically. +/** Flip ATI1 block vertically. */ void BlockATI1::flip4() { alpha.flip4(); } -/// Flip half ATI1 block vertically. +/** Flip half ATI1 block vertically. */ void BlockATI1::flip2() { alpha.flip2(); } -/// Decode ATI2 block. +/** Decode ATI2 block. */ void BlockATI2::decodeBlock(ColorBlock *block) const { uint8 alpha_array[8]; @@ -525,14 +525,14 @@ void BlockATI2::decodeBlock(ColorBlock *block) const } } -/// Flip ATI2 block vertically. +/** Flip ATI2 block vertically. */ void BlockATI2::flip4() { x.flip4(); y.flip4(); } -/// Flip half ATI2 block vertically. +/** Flip half ATI2 block vertically. */ void BlockATI2::flip2() { x.flip2(); @@ -586,14 +586,14 @@ void BlockCTX1::setIndices(const int *idx) } } -/// Flip CTX1 block vertically. +/** Flip CTX1 block vertically. */ inline void BlockCTX1::flip4() { swap(row[0], row[3]); swap(row[1], row[2]); } -/// Flip half CTX1 block vertically. +/** Flip half CTX1 block vertically. */ inline void BlockCTX1::flip2() { swap(row[0], row[1]); diff --git a/source/blender/imbuf/intern/dds/BlockDXT.h b/source/blender/imbuf/intern/dds/BlockDXT.h index 70ec8808c61..83cc147c76c 100644 --- a/source/blender/imbuf/intern/dds/BlockDXT.h +++ b/source/blender/imbuf/intern/dds/BlockDXT.h @@ -55,7 +55,7 @@ #include <Common.h> #include <Stream.h> -/// DXT1 block. +/** DXT1 block. */ struct BlockDXT1 { Color16 col0; Color16 col1; @@ -81,13 +81,13 @@ struct BlockDXT1 { void flip2(); }; -/// Return true if the block uses four color mode, false otherwise. +/** Return true if the block uses four color mode, false otherwise. */ inline bool BlockDXT1::isFourColorMode() const { return col0.u > col1.u; } -/// DXT3 alpha block with explicit alpha. +/** DXT3 alpha block with explicit alpha. */ struct AlphaBlockDXT3 { union { struct { @@ -117,7 +117,7 @@ struct AlphaBlockDXT3 { void flip2(); }; -/// DXT3 block. +/** DXT3 block. */ struct BlockDXT3 { AlphaBlockDXT3 alpha; BlockDXT1 color; @@ -129,7 +129,7 @@ struct BlockDXT3 { void flip2(); }; -/// DXT5 alpha block. +/** DXT5 alpha block. */ struct AlphaBlockDXT5 { // uint64 unions do not compile on all platforms #if 0 @@ -245,7 +245,7 @@ struct AlphaBlockDXT5 { void flip2(); }; -/// DXT5 block. +/** DXT5 block. */ struct BlockDXT5 { AlphaBlockDXT5 alpha; BlockDXT1 color; @@ -257,7 +257,7 @@ struct BlockDXT5 { void flip2(); }; -/// ATI1 block. +/** ATI1 block. */ struct BlockATI1 { AlphaBlockDXT5 alpha; @@ -267,7 +267,7 @@ struct BlockATI1 { void flip2(); }; -/// ATI2 block. +/** ATI2 block. */ struct BlockATI2 { AlphaBlockDXT5 x; AlphaBlockDXT5 y; @@ -278,7 +278,7 @@ struct BlockATI2 { void flip2(); }; -/// CTX1 block. +/** CTX1 block. */ struct BlockCTX1 { uint8 col0[2]; uint8 col1[2]; diff --git a/source/blender/imbuf/intern/dds/Color.h b/source/blender/imbuf/intern/dds/Color.h index d0b67d4638c..4a9202617f5 100644 --- a/source/blender/imbuf/intern/dds/Color.h +++ b/source/blender/imbuf/intern/dds/Color.h @@ -29,7 +29,7 @@ #pragma once -/// 32 bit color stored as BGRA. +/** 32 bit color stored as BGRA. */ class Color32 { public: Color32() @@ -93,7 +93,7 @@ class Color32 { }; }; -/// 16 bit 565 BGR color. +/** 16 bit 565 BGR color. */ class Color16 { public: Color16() diff --git a/source/blender/imbuf/intern/dds/ColorBlock.cpp b/source/blender/imbuf/intern/dds/ColorBlock.cpp index 69757d797b5..f2e8e0b0313 100644 --- a/source/blender/imbuf/intern/dds/ColorBlock.cpp +++ b/source/blender/imbuf/intern/dds/ColorBlock.cpp @@ -46,12 +46,12 @@ inline static uint colorDistance(Color32 c0, Color32 c1) } #endif -/// Default constructor. +/** Default constructor. */ ColorBlock::ColorBlock() { } -/// Init the color block from an array of colors. +/** Init the color block from an array of colors. */ ColorBlock::ColorBlock(const uint *linearImage) { for (uint i = 0; i < 16; i++) { @@ -59,7 +59,7 @@ ColorBlock::ColorBlock(const uint *linearImage) } } -/// Init the color block with the contents of the given block. +/** Init the color block with the contents of the given block. */ ColorBlock::ColorBlock(const ColorBlock &block) { for (uint i = 0; i < 16; i++) { @@ -67,7 +67,7 @@ ColorBlock::ColorBlock(const ColorBlock &block) } } -/// Initialize this color block. +/** Initialize this color block. */ ColorBlock::ColorBlock(const Image *img, uint x, uint y) { init(img, x, y); @@ -159,7 +159,7 @@ void ColorBlock::swizzle(uint x, uint y, uint z, uint w) } } -/// Returns true if the block has a single color. +/** Returns true if the block has a single color. */ bool ColorBlock::isSingleColor(Color32 mask /*= Color32(0xFF, 0xFF, 0xFF, 0x00)*/) const { uint u = m_color[0].u & mask.u; @@ -174,7 +174,7 @@ bool ColorBlock::isSingleColor(Color32 mask /*= Color32(0xFF, 0xFF, 0xFF, 0x00)* } #if 0 -/// Returns true if the block has a single color, ignoring transparent pixels. +/** Returns true if the block has a single color, ignoring transparent pixels. */ bool ColorBlock::isSingleColorNoAlpha() const { Color32 c; @@ -199,7 +199,7 @@ bool ColorBlock::isSingleColorNoAlpha() const #endif #if 0 -/// Count number of unique colors in this color block. +/** Count number of unique colors in this color block. */ uint ColorBlock::countUniqueColors() const { uint count = 0; @@ -223,7 +223,7 @@ uint ColorBlock::countUniqueColors() const #endif #if 0 -/// Get average color of the block. +/** Get average color of the block. */ Color32 ColorBlock::averageColor() const { uint r, g, b, a; @@ -240,7 +240,7 @@ Color32 ColorBlock::averageColor() const } #endif -/// Return true if the block is not fully opaque. +/** Return true if the block is not fully opaque. */ bool ColorBlock::hasAlpha() const { for (uint i = 0; i < 16; i++) { @@ -253,7 +253,7 @@ bool ColorBlock::hasAlpha() const #if 0 -/// Get diameter color range. +/** Get diameter color range. */ void ColorBlock::diameterRange(Color32 *start, Color32 *end) const { Color32 c0, c1; @@ -274,7 +274,7 @@ void ColorBlock::diameterRange(Color32 *start, Color32 *end) const *end = c1; } -/// Get luminance color range. +/** Get luminance color range. */ void ColorBlock::luminanceRange(Color32 *start, Color32 *end) const { Color32 minColor, maxColor; @@ -299,7 +299,7 @@ void ColorBlock::luminanceRange(Color32 *start, Color32 *end) const *end = maxColor; } -/// Get color range based on the bounding box. +/** Get color range based on the bounding box. */ void ColorBlock::boundsRange(Color32 *start, Color32 *end) const { Color32 minColor(255, 255, 255); @@ -344,7 +344,7 @@ void ColorBlock::boundsRange(Color32 *start, Color32 *end) const *end = maxColor; } -/// Get color range based on the bounding box. +/** Get color range based on the bounding box. */ void ColorBlock::boundsRangeAlpha(Color32 *start, Color32 *end) const { Color32 minColor(255, 255, 255, 255); @@ -400,7 +400,7 @@ void ColorBlock::boundsRangeAlpha(Color32 *start, Color32 *end) const #endif #if 0 -/// Sort colors by abosolute value in their 16 bit representation. +/** Sort colors by abosolute value in their 16 bit representation. */ void ColorBlock::sortColorsByAbsoluteValue() { // Dummy selection sort. @@ -422,7 +422,7 @@ void ColorBlock::sortColorsByAbsoluteValue() #endif #if 0 -/// Find extreme colors in the given axis. +/** Find extreme colors in the given axis. */ void ColorBlock::computeRange(Vector3::Arg axis, Color32 *start, Color32 *end) const { @@ -452,7 +452,7 @@ void ColorBlock::computeRange(Vector3::Arg axis, Color32 *start, Color32 *end) c #endif #if 0 -/// Sort colors in the given axis. +/** Sort colors in the given axis. */ void ColorBlock::sortColors(const Vector3 &axis) { float luma_array[16]; @@ -477,7 +477,7 @@ void ColorBlock::sortColors(const Vector3 &axis) #endif #if 0 -/// Get the volume of the color block. +/** Get the volume of the color block. */ float ColorBlock::volume() const { Box bounds; diff --git a/source/blender/imbuf/intern/dds/ColorBlock.h b/source/blender/imbuf/intern/dds/ColorBlock.h index dd63286e230..98b4c9cb40a 100644 --- a/source/blender/imbuf/intern/dds/ColorBlock.h +++ b/source/blender/imbuf/intern/dds/ColorBlock.h @@ -32,7 +32,7 @@ #include <Color.h> #include <Image.h> -/// Uncompressed 4x4 color block. +/** Uncompressed 4x4 color block. */ struct ColorBlock { ColorBlock(); ColorBlock(const uint *linearImage); @@ -61,31 +61,31 @@ struct ColorBlock { Color32 m_color[4 * 4]; }; -/// Get pointer to block colors. +/** Get pointer to block colors. */ inline const Color32 *ColorBlock::colors() const { return m_color; } -/// Get block color. +/** Get block color. */ inline Color32 ColorBlock::color(uint i) const { return m_color[i]; } -/// Get block color. +/** Get block color. */ inline Color32 &ColorBlock::color(uint i) { return m_color[i]; } -/// Get block color. +/** Get block color. */ inline Color32 ColorBlock::color(uint x, uint y) const { return m_color[y * 4 + x]; } -/// Get block color. +/** Get block color. */ inline Color32 &ColorBlock::color(uint x, uint y) { return m_color[y * 4 + x]; diff --git a/source/blender/imbuf/intern/dds/DirectDrawSurface.h b/source/blender/imbuf/intern/dds/DirectDrawSurface.h index ac7f893fddd..373d5974a5e 100644 --- a/source/blender/imbuf/intern/dds/DirectDrawSurface.h +++ b/source/blender/imbuf/intern/dds/DirectDrawSurface.h @@ -73,7 +73,7 @@ struct DDSCaps { uint caps4; }; -/// DDS file header for DX10. +/** DDS file header for DX10. */ struct DDSHeader10 { uint dxgiFormat; uint resourceDimension; @@ -82,7 +82,7 @@ struct DDSHeader10 { uint reserved; }; -/// DDS file header. +/** DDS file header. */ struct DDSHeader { uint fourcc; uint size; @@ -132,7 +132,7 @@ struct DDSHeader { uint d3d9Format() const; }; -/// DirectDraw Surface. (DDS) +/** DirectDraw Surface. (DDS) */ class DirectDrawSurface { public: DirectDrawSurface(unsigned char *mem, uint size); diff --git a/source/blender/imbuf/intern/dds/Image.h b/source/blender/imbuf/intern/dds/Image.h index 4ccfec99445..0f977641d89 100644 --- a/source/blender/imbuf/intern/dds/Image.h +++ b/source/blender/imbuf/intern/dds/Image.h @@ -32,7 +32,7 @@ #include "Color.h" #include "Common.h" -/// 32 bit RGBA image. +/** 32 bit RGBA image. */ class Image { public: enum Format { |