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

   1 /*
   2  * Copyright(c) 2021 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 data.<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         /// <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.New(PropertyMap.getCPtr(bufferFormat)), true)
  36         {
  37             if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
  38         }
  39
  40         internal PropertyBuffer(global::System.IntPtr cPtr, bool cMemoryOwn) : base(cPtr, cMemoryOwn)
  41         {
  42         }
  43
  44         /// <summary>
  45         /// Updates the whole buffer information.<br />
  46         /// This function expects a pointer to an array of structures with the same
  47         /// format that was given in the construction, and the number of elements to
  48         /// be the same as the size of the buffer.<br />
  49         /// </summary>
  50         /// <param name="data">A pointer to the data that will be copied to the buffer.</param>
  51         /// <param name="size">Number of elements to expand or contract the buffer.</param>
  52         [EditorBrowsable(EditorBrowsableState.Never)]
  53         public void SetData(System.IntPtr data, uint size)
  54         {
  55             Interop.PropertyBuffer.SetData(SwigCPtr, data, size);
  56             if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
  57         }
  58
  59         /// <summary>
  60         /// Gets the number of elements in the buffer.
  61         /// </summary>
  62         /// <returns>Number of elements to expand or contract the buffer.</returns>
  63         /// <since_tizen> 3 </since_tizen>
  64         public uint GetSize()
  65         {
  66             uint ret = Interop.PropertyBuffer.GetSize(SwigCPtr);
  67             if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
  68             return ret;
  69         }
  70
  71         internal static global::System.Runtime.InteropServices.HandleRef getCPtr(PropertyBuffer obj)
  72         {
  73             return (obj == null) ? new global::System.Runtime.InteropServices.HandleRef(null, global::System.IntPtr.Zero) : obj.SwigCPtr;
  74         }
  75
  76         /// This will not be public opened.
  77         [EditorBrowsable(EditorBrowsableState.Never)]
  78         protected override void ReleaseSwigCPtr(System.Runtime.InteropServices.HandleRef swigCPtr)
  79         {
  80             Interop.PropertyBuffer.DeletePropertyBuffer(swigCPtr);
  81         }
  82     }
  83 }