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