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