src/Tizen.NUI/src/public/PropertyBuffer.cs

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