src/Tizen.NUI/src/public/PropertyBuffer.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 using System.ComponentModel;
  18
  19 namespace Tizen.NUI
  20 {
  21     /// <summary>
  22     /// PropertyBuffer is a handle to an object that contains a buffer of structured properties.<br />
  23     /// PropertyBuffers can be used to provide data to Geometry objects.
  24     /// </summary>
  25     /// <since_tizen> 3 </since_tizen>
  26     public class PropertyBuffer : BaseHandle
  27     {
  28         private global::System.Runtime.InteropServices.HandleRef swigCPtr;
  29
  30         /// <summary>
  31         /// Creates a PropertyBuffer.
  32         /// </summary>
  33         /// <param name="bufferFormat">The map of names and types that describes the components of the buffer.</param>
  34         /// <since_tizen> 3 </since_tizen>
  35         public PropertyBuffer(PropertyMap bufferFormat) : this(Interop.PropertyBuffer.PropertyBuffer_New(PropertyMap.getCPtr(bufferFormat)), true)
  36         {
  37             if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
  38
  39         }
  40
  41         internal PropertyBuffer(global::System.IntPtr cPtr, bool cMemoryOwn) : base(Interop.PropertyBuffer.PropertyBuffer_SWIGUpcast(cPtr), cMemoryOwn)
  42         {
  43             swigCPtr = new global::System.Runtime.InteropServices.HandleRef(this, cPtr);
  44         }
  45
  46         /// <summary>
  47         /// Updates the whole buffer information.<br />
  48         /// This function expects a pointer to an array of structures with the same
  49         /// format that was given in the construction, and the number of elements to
  50         /// be the same as the size of the buffer.<br />
  51         /// </summary>
  52         /// <param name="data">A pointer to the data that will be copied to the buffer.</param>
  53         /// <param name="size">Number of elements to expand or contract the buffer.</param>
  54         /// <since_tizen> 3 </since_tizen>
  55         public void SetData(System.IntPtr data, uint size)
  56         {
  57             Interop.PropertyBuffer.PropertyBuffer_SetData(swigCPtr, data, size);
  58             if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
  59         }
  60
  61         /// <summary>
  62         /// Gets the number of elements in the buffer.
  63         /// </summary>
  64         /// <returns>Number of elements to expand or contract the buffer.</returns>
  65         /// <since_tizen> 3 </since_tizen>
  66         public uint GetSize()
  67         {
  68             uint ret = Interop.PropertyBuffer.PropertyBuffer_GetSize(swigCPtr);
  69             if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
  70             return ret;
  71         }
  72
  73         internal static global::System.Runtime.InteropServices.HandleRef getCPtr(PropertyBuffer obj)
  74         {
  75             return (obj == null) ? new global::System.Runtime.InteropServices.HandleRef(null, global::System.IntPtr.Zero) : obj.swigCPtr;
  76         }
  77
  78         /// <summary>
  79         /// Dispose.
  80         /// </summary>
  81         /// <since_tizen> 3 </since_tizen>
  82         protected override void Dispose(DisposeTypes type)
  83         {
  84             if (disposed)
  85             {
  86                 return;
  87             }
  88
  89             //Release your own unmanaged resources here.
  90             //You should not access any managed member here except static instance.
  91             //because the execution order of Finalizes is non-deterministic.
  92
  93             if (swigCPtr.Handle != global::System.IntPtr.Zero)
  94             {
  95                 if (swigCMemOwn)
  96                 {
  97                     swigCMemOwn = false;
  98                     Interop.PropertyBuffer.delete_PropertyBuffer(swigCPtr);
  99                 }
 100                 swigCPtr = new global::System.Runtime.InteropServices.HandleRef(null, global::System.IntPtr.Zero);
 101             }
 102
 103             base.Dispose(type);
 104         }
 105     }
 106 }