Make signals arguments clearer

Former-commit-id: c329f1fc5b8d8ffcf8e38ec4e4804454b31f685f
This commit is contained in:
Lynix 2015-09-14 22:40:38 +02:00
parent 9f1c190985
commit 03ee0a12ed
29 changed files with 72 additions and 68 deletions

View File

@ -70,8 +70,8 @@ class NAZARA_AUDIO_API NzSoundBuffer : public NzRefCounted, public NzResource, N
template<typename... Args> static NzSoundBufferRef New(Args&&... args);
// Signals:
NazaraSignal(OnSoundBufferDestroy, const NzSoundBuffer*); //< Args: me
NazaraSignal(OnSoundBufferRelease, const NzSoundBuffer*); //< Args: me
NazaraSignal(OnSoundBufferDestroy, const NzSoundBuffer* /*soundBuffer*/);
NazaraSignal(OnSoundBufferRelease, const NzSoundBuffer* /*soundBuffer*/);
private:
unsigned int GetOpenALBuffer() const;

View File

@ -46,8 +46,8 @@ class NAZARA_GRAPHICS_API NzInstancedRenderable : public NzRefCounted
inline NzInstancedRenderable& operator=(const NzInstancedRenderable& renderable);
// Signals:
NazaraSignal(OnInstancedRenderableInvalidateData, const NzInstancedRenderable*, nzUInt32); //< Args: me, flags
NazaraSignal(OnInstancedRenderableRelease, const NzInstancedRenderable*); //< Args: me
NazaraSignal(OnInstancedRenderableInvalidateData, const NzInstancedRenderable* /*instancedRenderable*/, nzUInt32 /*flags*/);
NazaraSignal(OnInstancedRenderableRelease, const NzInstancedRenderable* /*instancedRenderable*/);
struct InstanceData
{

View File

@ -141,9 +141,9 @@ class NAZARA_GRAPHICS_API NzMaterial : public NzRefCounted, public NzResource
static NzMaterialRef GetDefault();
template<typename... Args> static NzMaterialRef New(Args&&... args);
// Signals
NazaraSignal(OnMaterialRelease, const NzMaterial*); //< Args: me
NazaraSignal(OnMaterialReset, const NzMaterial*); //< Args: me
// Signals:
NazaraSignal(OnMaterialRelease, const NzMaterial* /*material*/);
NazaraSignal(OnMaterialReset, const NzMaterial* /*material*/);
private:
struct ShaderInstance

View File

@ -35,7 +35,7 @@ class NAZARA_GRAPHICS_API NzParticleController : public NzRefCounted
virtual void Apply(NzParticleSystem& system, NzParticleMapper& mapper, unsigned int startId, unsigned int endId, float elapsedTime) = 0;
// Signals:
NazaraSignal(OnParticleControllerRelease, const NzParticleController*); //< Args: me
NazaraSignal(OnParticleControllerRelease, const NzParticleController* /*particleController*/);
private:
static bool Initialize();

View File

@ -45,8 +45,8 @@ class NAZARA_GRAPHICS_API NzParticleDeclaration : public NzRefCounted
static NzParticleDeclaration* Get(nzParticleLayout layout);
static bool IsTypeSupported(nzComponentType type);
// Signals
NazaraSignal(OnParticleDeclarationRelease, const NzParticleDeclaration*); //< Args: me
// Signals:
NazaraSignal(OnParticleDeclarationRelease, const NzParticleDeclaration* /*particleDeclaration*/);
private:
static bool Initialize();

View File

@ -35,7 +35,7 @@ class NAZARA_GRAPHICS_API NzParticleGenerator : public NzRefCounted
virtual void Generate(NzParticleSystem& system, NzParticleMapper& mapper, unsigned int startId, unsigned int endId) = 0;
// Signals:
NazaraSignal(OnParticleGeneratorRelease, const NzParticleGenerator*); //< Args: me
NazaraSignal(OnParticleGeneratorRelease, const NzParticleGenerator* /*particleGenerator*/);
private:
static bool Initialize();

View File

@ -36,7 +36,7 @@ class NAZARA_GRAPHICS_API NzParticleRenderer : public NzRefCounted
virtual void Render(const NzParticleSystem& system, const NzParticleMapper& mapper, unsigned int startId, unsigned int endId, NzAbstractRenderQueue* renderQueue) = 0;
// Signals:
NazaraSignal(OnParticleRendererRelease, const NzParticleRenderer*); //< Args: me
NazaraSignal(OnParticleRendererRelease, const NzParticleRenderer* /*particleRenderer*/);
private:
static bool Initialize();

View File

@ -51,7 +51,8 @@ class NAZARA_PHYSICS_API NzPhysGeom : public NzRefCounted, NzNonCopyable
static NzPhysGeomRef Build(const NzPrimitiveList& list);
NazaraSignal(OnPhysGeomRelease, const NzPhysGeom*); //< Args: me
// Signals:
NazaraSignal(OnPhysGeomRelease, const NzPhysGeom* /*physGeom*/);
protected:
virtual NewtonCollision* CreateHandle(NzPhysWorld* world) const = 0;

View File

@ -47,9 +47,9 @@ class NAZARA_RENDERER_API NzContext : public NzRefCounted
static const NzContext* GetReference();
static const NzContext* GetThreadContext();
// Signals
NazaraSignal(OnContextDestroy, const NzContext*); //< Args: me
NazaraSignal(OnContextRelease, const NzContext*); //< Args: me
// Signals:
NazaraSignal(OnContextDestroy, const NzContext* /*context*/);
NazaraSignal(OnContextRelease, const NzContext* /*context*/);
private:
static bool Initialize();

View File

@ -46,9 +46,9 @@ class NAZARA_RENDERER_API NzRenderBuffer : public NzRefCounted, NzNonCopyable
static bool IsSupported();
template<typename... Args> static NzRenderBufferRef New(Args&&... args);
// Signals
NazaraSignal(OnRenderBufferDestroy, const NzRenderBuffer*); //< Args: me
NazaraSignal(OnRenderBufferRelease, const NzRenderBuffer*); //< Args: me
// Signals:
NazaraSignal(OnRenderBufferDestroy, const NzRenderBuffer* /*renderBuffer*/);
NazaraSignal(OnRenderBufferRelease, const NzRenderBuffer* /*renderBuffer*/);
private:
static bool Initialize();

View File

@ -35,10 +35,10 @@ class NAZARA_RENDERER_API NzRenderTarget
// Fonctions OpenGL
virtual bool HasContext() const = 0;
// Signals
NazaraSignal(OnRenderTargetParametersChange, const NzRenderTarget*); //< Args: me
NazaraSignal(OnRenderTargetRelease, const NzRenderTarget*); //< Args: me
NazaraSignal(OnRenderTargetSizeChange, const NzRenderTarget*); //< Args: me
// Signals:
NazaraSignal(OnRenderTargetParametersChange, const NzRenderTarget* /*renderTarget*/);
NazaraSignal(OnRenderTargetRelease, const NzRenderTarget* /*renderTarget*/);
NazaraSignal(OnRenderTargetSizeChange, const NzRenderTarget* /*renderTarget*/);
protected:
virtual bool Activate() const = 0;

View File

@ -101,10 +101,10 @@ class NAZARA_RENDERER_API NzShader : public NzRefCounted, NzNonCopyable
static bool IsStageSupported(nzShaderStage stage);
template<typename... Args> static NzShaderRef New(Args&&... args);
// Signals
NazaraSignal(OnShaderDestroy, const NzShader*); //< Args: me
NazaraSignal(OnShaderRelease, const NzShader*); //< Args: me
NazaraSignal(OnShaderUniformInvalidated, const NzShader*); //< Args: me
// Signals:
NazaraSignal(OnShaderDestroy, const NzShader* /*shader*/);
NazaraSignal(OnShaderRelease, const NzShader* /*shader*/);
NazaraSignal(OnShaderUniformInvalidated, const NzShader* /*shader*/);
private:
bool PostLinkage();

View File

@ -108,9 +108,9 @@ class NAZARA_RENDERER_API NzTexture : public NzAbstractImage, public NzRefCounte
static bool IsTypeSupported(nzImageType type);
template<typename... Args> static NzTextureRef New(Args&&... args);
// Signals
NazaraSignal(OnTextureDestroy, const NzTexture*); //< Args: me
NazaraSignal(OnTextureRelease, const NzTexture*); //< Args: me
// Signals:
NazaraSignal(OnTextureDestroy, const NzTexture* /*texture*/);
NazaraSignal(OnTextureRelease, const NzTexture* /*texture*/);
private:
bool CreateTexture(bool proxy);

View File

@ -32,7 +32,8 @@ class NAZARA_RENDERER_API NzUberShader : public NzRefCounted
virtual NzUberShaderInstance* Get(const NzParameterList& parameters) const = 0;
NazaraSignal(OnUberShaderRelease, const NzUberShader*); //< Args: me
// Signals:
NazaraSignal(OnUberShaderRelease, const NzUberShader* /*uberShader*/);
private:
static bool Initialize();

View File

@ -36,7 +36,7 @@ class NAZARA_RENDERER_API NzUberShaderPreprocessor : public NzUberShader
template<typename... Args> static NzUberShaderPreprocessorRef New(Args&&... args);
// Signals:
NazaraSignal(OnUberShaderPreprocessorRelease, const NzUberShaderPreprocessor*); //< Args: me
NazaraSignal(OnUberShaderPreprocessorRelease, const NzUberShaderPreprocessor* /*uberShaderPreprocessor*/);
private:
struct Shader

View File

@ -31,9 +31,10 @@ class NAZARA_UTILITY_API NzAbstractAtlas
virtual nzUInt32 GetStorage() const = 0;
virtual bool Insert(const NzImage& image, NzRectui* rect, bool* flipped, unsigned int* layerIndex) = 0;
NazaraSignal(OnAtlasCleared, const NzAbstractAtlas*); //< Args: me
NazaraSignal(OnAtlasLayerChange, const NzAbstractAtlas*, NzAbstractImage*, NzAbstractImage*); //< Args: me, oldLayer, newLayer
NazaraSignal(OnAtlasRelease, const NzAbstractAtlas*); //< Args: me
// Signals:
NazaraSignal(OnAtlasCleared, const NzAbstractAtlas* /*atlas*/);
NazaraSignal(OnAtlasLayerChange, const NzAbstractAtlas* /*atlas*/, NzAbstractImage* /*oldLayer*/, NzAbstractImage* /*newLayer*/);
NazaraSignal(OnAtlasRelease, const NzAbstractAtlas* /*atlas*/);
};
#endif // NAZARA_ABSTRACTATLAS_HPP

View File

@ -88,9 +88,9 @@ class NAZARA_UTILITY_API NzAnimation : public NzRefCounted, public NzResource
template<typename... Args> static NzAnimationRef New(Args&&... args);
// Signals
NazaraSignal(OnAnimationDestroy, const NzAnimation*); //< Args: me
NazaraSignal(OnAnimationRelease, const NzAnimation*); //< Args: me
// Signals:
NazaraSignal(OnAnimationDestroy, const NzAnimation* /*animation*/);
NazaraSignal(OnAnimationRelease, const NzAnimation* /*animation*/);
private:
static bool Initialize();

View File

@ -61,8 +61,8 @@ class NAZARA_UTILITY_API NzBuffer : public NzRefCounted, NzNonCopyable
static void SetBufferFactory(nzUInt32 storage, BufferFactory func);
// Signals:
NazaraSignal(OnBufferDestroy, const NzBuffer*); //< Args: me
NazaraSignal(OnBufferRelease, const NzBuffer*); //< Args: me
NazaraSignal(OnBufferDestroy, const NzBuffer* /*buffer*/);
NazaraSignal(OnBufferRelease, const NzBuffer* /*buffer*/);
private:
static bool Initialize();

View File

@ -112,13 +112,14 @@ class NAZARA_UTILITY_API NzFont : public NzRefCounted, public NzResource, NzNonC
float underlineThickness;
};
NazaraSignal(OnFontAtlasChanged, const NzFont*); //< Args: me
NazaraSignal(OnFontAtlasLayerChanged, const NzFont*, NzAbstractImage*, NzAbstractImage*); //< Args: me, old layer, new layer
NazaraSignal(OnFontDestroy, const NzFont*); //< Args: me
NazaraSignal(OnFontGlyphCacheCleared, const NzFont*); //< Args: me
NazaraSignal(OnFontKerningCacheCleared, const NzFont*); //< Args: me
NazaraSignal(OnFontRelease, const NzFont*); //< Args: me
NazaraSignal(OnFontSizeInfoCacheCleared, const NzFont*); //< Args: me
// Signals:
NazaraSignal(OnFontAtlasChanged, const NzFont* /*font*/);
NazaraSignal(OnFontAtlasLayerChanged, const NzFont* /*font*/, NzAbstractImage* /*oldLayer*/, NzAbstractImage* /*newLayer*/);
NazaraSignal(OnFontDestroy, const NzFont* /*font*/);
NazaraSignal(OnFontGlyphCacheCleared, const NzFont* /*font*/);
NazaraSignal(OnFontKerningCacheCleared, const NzFont* /*font*/);
NazaraSignal(OnFontRelease, const NzFont* /*font*/);
NazaraSignal(OnFontSizeInfoCacheCleared, const NzFont* /*font*/);
private:
using GlyphMap = std::unordered_map<char32_t, Glyph>;

View File

@ -147,8 +147,8 @@ class NAZARA_UTILITY_API NzImage : public NzAbstractImage, public NzRefCounted,
static SharedImage emptyImage;
// Signals:
NazaraSignal(OnImageDestroy, const NzImage*); //< Args: me
NazaraSignal(OnImageRelease, const NzImage*); //< Args: me
NazaraSignal(OnImageDestroy, const NzImage* /*image*/);
NazaraSignal(OnImageRelease, const NzImage* /*image*/);
private:
void EnsureOwnership();

View File

@ -64,8 +64,8 @@ class NAZARA_UTILITY_API NzIndexBuffer : public NzRefCounted
template<typename... Args> static NzIndexBufferRef New(Args&&... args);
// Signals
NazaraSignal(OnIndexBufferRelease, const NzIndexBuffer*); //< Args: me
// Signals:
NazaraSignal(OnIndexBufferRelease, const NzIndexBuffer* /*indexBuffer*/);
private:
NzBufferRef m_buffer;

View File

@ -129,8 +129,8 @@ class NAZARA_UTILITY_API NzMesh : public NzRefCounted, public NzResource
template<typename... Args> static NzMeshRef New(Args&&... args);
// Signals:
NazaraSignal(OnMeshDestroy, const NzMesh*); //< Args: me
NazaraSignal(OnMeshRelease, const NzMesh*); //< Args: me
NazaraSignal(OnMeshDestroy, const NzMesh* /*mesh*/);
NazaraSignal(OnMeshRelease, const NzMesh* /*mesh*/);
private:
NzMeshImpl* m_impl = nullptr;

View File

@ -92,9 +92,9 @@ class NAZARA_UTILITY_API NzNode
NzNode& operator=(const NzNode& node);
// Signals:
NazaraSignal(OnNodeInvalidation, const NzNode*); //< Args: me
NazaraSignal(OnNodeNewParent, const NzNode*, const NzNode*); //< Args: me, new parent
NazaraSignal(OnNodeRelease, const NzNode*); //< Args: me
NazaraSignal(OnNodeInvalidation, const NzNode* /*node*/);
NazaraSignal(OnNodeNewParent, const NzNode* /*node*/, const NzNode* /*parent*/);
NazaraSignal(OnNodeRelease, const NzNode* /*node*/);
protected:
void AddChild(NzNode* node) const;

View File

@ -42,8 +42,8 @@ class NAZARA_UTILITY_API NzSkeletalMesh final : public NzSubMesh
template<typename... Args> static NzSkeletalMeshRef New(Args&&... args);
// Signals:
NazaraSignal(OnSkeletalMeshDestroy, const NzSkeletalMesh*); //< Args: me
NazaraSignal(OnSkeletalMeshRelease, const NzSkeletalMesh*); //< Args: me
NazaraSignal(OnSkeletalMeshDestroy, const NzSkeletalMesh* /*skeletalMesh*/);
NazaraSignal(OnSkeletalMeshRelease, const NzSkeletalMesh* /*skeletalMesh*/);
private:
NzBoxf m_aabb;

View File

@ -58,9 +58,9 @@ class NAZARA_UTILITY_API NzSkeleton : public NzRefCounted
template<typename... Args> static NzSkeletonRef New(Args&&... args);
// Signals:
NazaraSignal(OnSkeletonDestroy, const NzSkeleton*); //< Args: me
NazaraSignal(OnSkeletonJointsInvalidated, const NzSkeleton*); //< Args: me
NazaraSignal(OnSkeletonRelease, const NzSkeleton*); //< Args: me
NazaraSignal(OnSkeletonDestroy, const NzSkeleton* /*skeleton*/);
NazaraSignal(OnSkeletonJointsInvalidated, const NzSkeleton* /*skeleton*/);
NazaraSignal(OnSkeletonRelease, const NzSkeleton* /*skeleton*/);
private:
void InvalidateJoints();

View File

@ -45,8 +45,8 @@ class NAZARA_UTILITY_API NzStaticMesh final : public NzSubMesh
template<typename... Args> static NzStaticMeshRef New(Args&&... args);
// Signals:
NazaraSignal(OnStaticMeshDestroy, const NzStaticMesh*); //< Args: me
NazaraSignal(OnStaticMeshRelease, const NzStaticMesh*); //< Args: me
NazaraSignal(OnStaticMeshDestroy, const NzStaticMesh* /*staticMesh*/);
NazaraSignal(OnStaticMeshRelease, const NzStaticMesh* /*staticMesh*/);
private:
NzBoxf m_aabb;

View File

@ -49,7 +49,7 @@ class NAZARA_UTILITY_API NzSubMesh : public NzRefCounted
void SetPrimitiveMode(nzPrimitiveMode mode);
// Signals:
NazaraSignal(OnSubMeshRelease, const NzSubMesh*); //< Args: me
NazaraSignal(OnSubMeshRelease, const NzSubMesh* /*subMesh*/);
protected:
nzPrimitiveMode m_primitiveMode;

View File

@ -62,8 +62,8 @@ class NAZARA_UTILITY_API NzVertexBuffer : public NzRefCounted
template<typename... Args> static NzVertexBufferRef New(Args&&... args);
// Signals
NazaraSignal(OnVertexBufferRelease, const NzVertexBuffer*); //< Args: me
// Signals:
NazaraSignal(OnVertexBufferRelease, const NzVertexBuffer* /*vertexBuffer*/);
private:
NzBufferRef m_buffer;

View File

@ -45,8 +45,8 @@ class NAZARA_UTILITY_API NzVertexDeclaration : public NzRefCounted
static bool IsTypeSupported(nzComponentType type);
template<typename... Args> static NzVertexDeclarationRef New(Args&&... args);
// Signals
NazaraSignal(OnVertexDeclarationRelease, const NzVertexDeclaration*); //< Args: me
// Signals:
NazaraSignal(OnVertexDeclarationRelease, const NzVertexDeclaration* /*vertexDeclaration*/);
private:
static bool Initialize();