src/Tizen.NUI/src/public/Texture.cs

   1 /*
   2  * Copyright(c) 2017 Samsung Electronics Co., Ltd.
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at
   7  *
   8  * http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  *
  16  */
  17
  18 namespace Tizen.NUI
  19 {
  20     /// <summary>
  21     /// Texture represents a texture object used as input or output by shaders.
  22     /// </summary>
  23     /// <since_tizen> 3 </since_tizen>
  24     public class Texture : BaseHandle
  25     {
  26         private global::System.Runtime.InteropServices.HandleRef swigCPtr;
  27
  28         /// <summary>
  29         /// Creates a new Texture object.
  30         /// </summary>
  31         /// <param name="type">The type of the texture.</param>
  32         /// <param name="format">The format of the pixel data.</param>
  33         /// <param name="width">The width of the texture.</param>
  34         /// <param name="height">The height of the texture.</param>
  35         /// <since_tizen> 3 </since_tizen>
  36         public Texture(TextureType type, PixelFormat format, uint width, uint height) : this(Interop.Texture.Texture_New__SWIG_0((int)type, (int)format, width, height), true)
  37         {
  38             if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
  39
  40         }
  41         internal Texture(NativeImageInterface nativeImageInterface) : this(Interop.Texture.Texture_New__SWIG_1(NativeImageInterface.getCPtr(nativeImageInterface)), true)
  42         {
  43             if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
  44
  45         }
  46
  47         internal Texture(global::System.IntPtr cPtr, bool cMemoryOwn) : base(Interop.Texture.Texture_SWIGUpcast(cPtr), cMemoryOwn)
  48         {
  49             swigCPtr = new global::System.Runtime.InteropServices.HandleRef(this, cPtr);
  50         }
  51
  52         /// <summary>
  53         /// Uploads data to the texture from a PixelData object.
  54         /// </summary>
  55         /// <param name="pixelData">The pixelData object.</param>
  56         /// <returns>True if the PixelData object has compatible pixel format and fits within the texture, false otherwise.</returns>
  57         /// <since_tizen> 3 </since_tizen>
  58         public bool Upload(PixelData pixelData)
  59         {
  60             bool ret = Interop.Texture.Texture_Upload__SWIG_0(swigCPtr, PixelData.getCPtr(pixelData));
  61             if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
  62             return ret;
  63         }
  64
  65         /// <summary>
  66         /// Uploads data to the texture from a PixelData object.
  67         /// </summary>
  68         /// <param name="pixelData">The pixelData object.</param>
  69         /// <param name="layer">The layer of a cube map or array texture.</param>
  70         /// <param name="mipmap">The level-of-detail number. Level 0 is the base image level. Level n is the nth mipmap reduction image.</param>
  71         /// <param name="xOffset">The horizontal offset of the rectangular area in the texture that will be updated.</param>
  72         /// <param name="yOffset">The vertical offset of the rectangular area in the texture that will be updated.</param>
  73         /// <param name="width">The width of the rectangular area in the texture that will be updated.</param>
  74         /// <param name="height">height of the rectangular area in the texture that will be updated.</param>
  75         /// <returns>True if the PixelData object has compatible pixel format and fits within the texture, false otherwise.</returns>
  76         /// <since_tizen> 3 </since_tizen>
  77         public bool Upload(PixelData pixelData, uint layer, uint mipmap, uint xOffset, uint yOffset, uint width, uint height)
  78         {
  79             bool ret = Interop.Texture.Texture_Upload__SWIG_1(swigCPtr, PixelData.getCPtr(pixelData), layer, mipmap, xOffset, yOffset, width, height);
  80             if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
  81             return ret;
  82         }
  83
  84         /// <summary>
  85         /// Generates mipmaps for the texture.<br />
  86         /// This will auto generate all the mipmaps for the texture based on the data in the base level.
  87         /// </summary>
  88         /// <since_tizen> 3 </since_tizen>
  89         public void GenerateMipmaps()
  90         {
  91             Interop.Texture.Texture_GenerateMipmaps(swigCPtr);
  92             if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
  93         }
  94
  95         /// <summary>
  96         /// Returns the width of the texture.<br />
  97         /// </summary>
  98         /// <returns>The width, in pixels, of the texture.</returns>
  99         /// <since_tizen> 3 </since_tizen>
 100         public uint GetWidth()
 101         {
 102             uint ret = Interop.Texture.Texture_GetWidth(swigCPtr);
 103             if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
 104             return ret;
 105         }
 106
 107         /// <summary>
 108         /// Returns the height of the texture..<br />
 109         /// </summary>
 110         /// <returns>The height, in pixels, of the texture.</returns>
 111         /// <since_tizen> 3 </since_tizen>
 112         public uint GetHeight()
 113         {
 114             uint ret = Interop.Texture.Texture_GetHeight(swigCPtr);
 115             if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
 116             return ret;
 117         }
 118
 119         internal static global::System.Runtime.InteropServices.HandleRef getCPtr(Texture obj)
 120         {
 121             return (obj == null) ? new global::System.Runtime.InteropServices.HandleRef(null, global::System.IntPtr.Zero) : obj.swigCPtr;
 122         }
 123
 124         /// <summary>
 125         /// Dispose.
 126         /// </summary>
 127         /// <since_tizen> 3 </since_tizen>
 128         protected override void Dispose(DisposeTypes type)
 129         {
 130             if (disposed)
 131             {
 132                 return;
 133             }
 134
 135             //Release your own unmanaged resources here.
 136             //You should not access any managed member here except static instance.
 137             //because the execution order of Finalizes is non-deterministic.
 138
 139             if (swigCPtr.Handle != global::System.IntPtr.Zero)
 140             {
 141                 if (swigCMemOwn)
 142                 {
 143                     swigCMemOwn = false;
 144                     Interop.Texture.delete_Texture(swigCPtr);
 145                 }
 146                 swigCPtr = new global::System.Runtime.InteropServices.HandleRef(null, global::System.IntPtr.Zero);
 147             }
 148
 149             base.Dispose(type);
 150         }
 151     }
 152 }