1 /*---------------------------------------------------------------------------*
2   Project:  NintendoWare
3   File:     anim_ResUtil.h
4 
5   Copyright (C)2009-2010 Nintendo Co., Ltd./HAL Laboratory, Inc.  All rights reserved.
6 
7   These coded instructions, statements, and computer programs contain
8   proprietary information of Nintendo of America Inc. and/or Nintendo
9   Company Ltd., and are protected by Federal copyright law.  They may
10   not be disclosed to third parties or copied or duplicated in any form,
11   in whole or in part, without the prior written consent of Nintendo.
12 
13   $Revision: 27943 $
14  *---------------------------------------------------------------------------*/
15 
16 #ifndef NW_ANIM_RESUTIL_H_
17 #define NW_ANIM_RESUTIL_H_
18 
19 #include <nw/anim/res/anim_ResAnim.h>
20 
21 namespace nw {
22 namespace anim {
23 namespace res {
24 
25 //! @brief テクスチャパターンアニメーションのクローンを行います。
26 //!
27 //! @details テクスチャパターンアニメーションを共有するために、浅いコピーを行います。
28 //!          内部でオリジナルへの参照を持つため、クローン元が破棄された後に使用すると
29 //!          正しい動作は保証されません。
30 //!
31 //!          MaterialAnimation以外を引数に渡すことは許されません。
32 //!          アサートが有効な場合はプログラムを停止します。無効の場合の動作は不定です。
33 //!
34 //! @return クローン結果の ResAnim を返します。この ResAnim は、再度 Setup を行う必要があります。
35 //!
36 ResAnim CloneTextureAnim(os::IAllocator* allocator, const ResAnim& src);
37 
38 //! @brief CloneTextureAnim で複製した ResAnim を破棄します。
39 //!
40 //! @details CloneTextureAnim の結果ではない ResAnim を引数に渡した時の動作は不定です。
41 //!          また、allocator には CloneTextureAnim に渡したものと同じものを使用してください。
42 //!
43 void DestroyClonedTextureAnim(os::IAllocator* allocator, ResAnim anim);
44 
45 } // namespace res
46 } // namespace anim
47 } // namespace nw
48 
49 #endif // NW_ANIM_RESUTIL_H_
50