You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
270 lines
8.8 KiB
270 lines
8.8 KiB
/****************************************************************************
|
|
Copyright (c) 2021-2023 Xiamen Yaji Software Co., Ltd.
|
|
|
|
http://www.cocos.com
|
|
|
|
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
of this software and associated documentation files (the "Software"), to deal
|
|
in the Software without restriction, including without limitation the rights to
|
|
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
|
|
of the Software, and to permit persons to whom the Software is furnished to do so,
|
|
subject to the following conditions:
|
|
|
|
The above copyright notice and this permission notice shall be included in
|
|
all copies or substantial portions of the Software.
|
|
|
|
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
|
THE SOFTWARE.
|
|
****************************************************************************/
|
|
|
|
#pragma once
|
|
|
|
#include "core/assets/Asset.h"
|
|
#include "core/assets/SimpleTexture.h"
|
|
|
|
namespace cc {
|
|
|
|
class ImageAsset;
|
|
class Texture2D;
|
|
struct ITexture2DCreateInfo;
|
|
|
|
using ITextureCubeCreateInfo = ITexture2DCreateInfo;
|
|
|
|
/**
|
|
* @en The texture cube mipmap interface
|
|
* @zh 立方体贴图的 Mipmap 接口。
|
|
*/
|
|
struct ITextureCubeMipmap {
|
|
IntrusivePtr<ImageAsset> front;
|
|
IntrusivePtr<ImageAsset> back;
|
|
IntrusivePtr<ImageAsset> left;
|
|
IntrusivePtr<ImageAsset> right;
|
|
IntrusivePtr<ImageAsset> top;
|
|
IntrusivePtr<ImageAsset> bottom;
|
|
};
|
|
|
|
struct ITextureCubeSerializeMipmapData {
|
|
ccstd::string front;
|
|
ccstd::string back;
|
|
ccstd::string left;
|
|
ccstd::string right;
|
|
ccstd::string top;
|
|
ccstd::string bottom;
|
|
};
|
|
|
|
/**
|
|
* @en The MipmapAtlas region interface
|
|
* @zh MipmapAtlas的region接口。
|
|
*/
|
|
struct MipmapAtlasLayoutInfo {
|
|
uint32_t left{0};
|
|
uint32_t top{0};
|
|
uint32_t width{0};
|
|
uint32_t height{0};
|
|
uint32_t level{0};
|
|
};
|
|
/**
|
|
* @en The texture cube MipmapAtlas interface
|
|
* @zh 立方体贴图的 MipmapAtlas 接口。
|
|
*/
|
|
struct TextureCubeMipmapAtlasInfo {
|
|
ITextureCubeMipmap atlas;
|
|
ccstd::vector<MipmapAtlasLayoutInfo> layout;
|
|
};
|
|
|
|
/**
|
|
* @en The way to fill mipmaps.
|
|
* @zh 填充mipmaps的方式。
|
|
*/
|
|
enum class MipmapMode {
|
|
/**
|
|
* @zh
|
|
* 不使用mipmaps
|
|
* @en
|
|
* Not using mipmaps
|
|
* @readonly
|
|
*/
|
|
NONE = 0,
|
|
/**
|
|
* @zh
|
|
* 使用自动生成的mipmaps
|
|
* @en
|
|
* Using the automatically generated mipmaps
|
|
* @readonly
|
|
*/
|
|
AUTO = 1,
|
|
/**
|
|
* @zh
|
|
* 使用卷积图填充mipmaps
|
|
* @en
|
|
* Filling mipmaps with convolutional maps.
|
|
* @readonly
|
|
*/
|
|
BAKED_CONVOLUTION_MAP = 2
|
|
};
|
|
struct TextureCubeSerializeData {
|
|
ccstd::string base;
|
|
bool rgbe{false};
|
|
MipmapMode mipmapMode{MipmapMode::NONE};
|
|
ccstd::vector<ITextureCubeSerializeMipmapData> mipmaps;
|
|
TextureCubeMipmapAtlasInfo mipmapAtlas;
|
|
};
|
|
|
|
/**
|
|
* @en The texture cube asset.
|
|
* Each mipmap level of a texture cube have 6 [[ImageAsset]], represents 6 faces of the cube.
|
|
* @zh 立方体贴图资源。
|
|
* 立方体贴图资源的每个 Mipmap 层级都为 6 张 [[ImageAsset]]，分别代表了立方体贴图的 6 个面。
|
|
*/
|
|
class TextureCube final : public SimpleTexture {
|
|
public:
|
|
using Super = SimpleTexture;
|
|
|
|
TextureCube();
|
|
~TextureCube() override;
|
|
|
|
/**
|
|
* @en The index for all faces of the cube
|
|
* @zh 立方体每个面的约定索引。
|
|
*/
|
|
enum class FaceIndex {
|
|
RIGHT = 0,
|
|
LEFT = 1,
|
|
TOP = 2,
|
|
BOTTOM = 3,
|
|
FRONT = 4,
|
|
BACK = 5,
|
|
};
|
|
|
|
/**
|
|
* @en Create a texture cube with an array of [[Texture2D]] which represents 6 faces of the texture cube.
|
|
* @zh 通过二维贴图数组指定每个 Mipmap 的每个面创建立方体贴图。
|
|
* @param textures Texture array, the texture count must be multiple of 6. Every 6 textures are 6 faces of a mipmap level.
|
|
* The order should obey [[FaceIndex]] order.
|
|
* @param out Output texture cube, if not given, will create a new texture cube.
|
|
* @returns The created texture cube.
|
|
* @example
|
|
* ```ts
|
|
* const textures = new Array<Texture2D>(6);
|
|
* textures[TextureCube.FaceIndex.front] = frontImage;
|
|
* textures[TextureCube.FaceIndex.back] = backImage;
|
|
* textures[TextureCube.FaceIndex.left] = leftImage;
|
|
* textures[TextureCube.FaceIndex.right] = rightImage;
|
|
* textures[TextureCube.FaceIndex.top] = topImage;
|
|
* textures[TextureCube.FaceIndex.bottom] = bottomImage;
|
|
* const textureCube = TextureCube.fromTexture2DArray(textures);
|
|
* ```
|
|
*/
|
|
static TextureCube *fromTexture2DArray(const ccstd::vector<Texture2D *> &textures);
|
|
|
|
/**
|
|
* @en All levels of mipmap images, be noted, automatically generated mipmaps are not included.
|
|
* When setup mipmap, the size of the texture and pixel format could be modified.
|
|
* @zh 所有层级 Mipmap，注意，这里不包含自动生成的 Mipmap。
|
|
* 当设置 Mipmap 时，贴图的尺寸以及像素格式可能会改变。
|
|
*/
|
|
const ccstd::vector<ITextureCubeMipmap> &getMipmaps() const {
|
|
return _mipmaps;
|
|
}
|
|
|
|
inline const TextureCubeMipmapAtlasInfo &getMipmapAtlas() const {
|
|
return _mipmapAtlas;
|
|
}
|
|
|
|
void setMipmaps(const ccstd::vector<ITextureCubeMipmap> &value);
|
|
|
|
void setMipmapsForJS(const ccstd::vector<ITextureCubeMipmap> &value);
|
|
|
|
void setMipmapAtlasForJS(const TextureCubeMipmapAtlasInfo &value);
|
|
|
|
/**
|
|
* @en Fill mipmaps with convolutional maps.
|
|
* @zh 使用卷积图填充mipmaps。
|
|
* @param value All mipmaps of each face of the cube map are stored in the form of atlas.
|
|
* and the value contains the atlas of the 6 faces and the layout information of each mipmap layer.
|
|
*/
|
|
void setMipmapAtlas(const TextureCubeMipmapAtlasInfo &value);
|
|
|
|
/**
|
|
* @en Level 0 mipmap image.
|
|
* Be noted, `this.image = img` equals `this.mipmaps = [img]`,
|
|
* sets image will clear all previous mipmaps.
|
|
* @zh 0 级 Mipmap。
|
|
* 注意，`this.image = img` 等价于 `this.mipmaps = [img]`，
|
|
* 也就是说，通过 `this.image` 设置 0 级 Mipmap 时将隐式地清除之前的所有 Mipmap。
|
|
*/
|
|
const ITextureCubeMipmap *getImage() const {
|
|
return _mipmaps.empty() ? nullptr : &_mipmaps[0];
|
|
}
|
|
|
|
void setImage(const ITextureCubeMipmap *value);
|
|
|
|
/**
|
|
* @en Reset the current texture with given size, pixel format and mipmap images.
|
|
* After reset, the gfx resource will become invalid, you must use [[uploadData]] explicitly to upload the new mipmaps to GPU resources.
|
|
* @zh 将当前贴图重置为指定尺寸、像素格式以及指定 mipmap 层级。重置后，贴图的像素数据将变为未定义。
|
|
* mipmap 图像的数据不会自动更新到贴图中，你必须显式调用 [[uploadData]] 来上传贴图数据。
|
|
* @param info The create information
|
|
*/
|
|
void reset(const ITextureCubeCreateInfo &info);
|
|
|
|
/**
|
|
* @en Release used GPU resources.
|
|
* @zh 释放占用的 GPU 资源。
|
|
* @deprecated please use [[destroy]] instead
|
|
*/
|
|
void releaseTexture();
|
|
|
|
// Override functions
|
|
void updateMipmaps(uint32_t firstLevel, uint32_t count) override;
|
|
|
|
/**
|
|
* @en Whether mipmaps are baked convolutional maps.
|
|
* @zh mipmaps是否为烘焙出来的卷积图。
|
|
*/
|
|
bool isUsingOfflineMipmaps() override;
|
|
|
|
void initialize();
|
|
void onLoaded() override;
|
|
/**
|
|
* 销毁此贴图，清空所有 Mipmap 并释放占用的 GPU 资源。
|
|
*/
|
|
bool destroy() override;
|
|
|
|
ccstd::any serialize(const ccstd::any &ctxForExporting) override;
|
|
void deserialize(const ccstd::any &serializedData, const ccstd::any &handle) override;
|
|
|
|
gfx::TextureInfo getGfxTextureCreateInfo(gfx::TextureUsageBit usage, gfx::Format format, uint32_t levelCount, gfx::TextureFlagBit flags) override;
|
|
gfx::TextureViewInfo getGfxTextureViewCreateInfo(gfx::Texture *texture, gfx::Format format, uint32_t baseLevel, uint32_t levelCount) override;
|
|
|
|
void initDefault(const ccstd::optional<ccstd::string> &uuid) override;
|
|
|
|
bool validate() const override;
|
|
//
|
|
|
|
/*@serializable*/
|
|
MipmapMode _mipmapMode{MipmapMode::NONE};
|
|
|
|
/*@serializable*/
|
|
bool isRGBE{false};
|
|
|
|
private:
|
|
void setMipmapParams(const ccstd::vector<ITextureCubeMipmap> &value);
|
|
|
|
/*@serializable*/
|
|
ccstd::vector<ITextureCubeMipmap> _mipmaps;
|
|
|
|
ccstd::vector<ITextureCubeMipmap> _generatedMipmaps;
|
|
|
|
/*@serializable*/
|
|
TextureCubeMipmapAtlasInfo _mipmapAtlas;
|
|
|
|
CC_DISALLOW_COPY_MOVE_ASSIGN(TextureCube);
|
|
};
|
|
|
|
} // namespace cc
|
|
|