-/** Copyright (c) 2017 Samsung Electronics Co., Ltd.
-*
-* Licensed under the Apache License, Version 2.0 (the "License");
-* you may not use this file except in compliance with the License.
-* You may obtain a copy of the License at
-*
-* http://www.apache.org/licenses/LICENSE-2.0
-*
-* Unless required by applicable law or agreed to in writing, software
-* distributed under the License is distributed on an "AS IS" BASIS,
-* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-* See the License for the specific language governing permissions and
-* limitations under the License.
-*
-*/
+/*
+ * Copyright(c) 2020 Samsung Electronics Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
+
+using System;
+using System.ComponentModel;
namespace Tizen.NUI
{
-
+ /// <summary>
+ /// The PixelData object holds a pixel buffer.<br />
+ /// The PixelData takes over the ownership of the pixel buffer.<br />
+ /// The buffer memory must not be released outside of this class, instead,
+ /// the PixelData object will release it automatically when the reference count falls to zero.
+ /// </summary>
+ /// Please DO NOT use! This will be deprecated!
+ /// PixelData class requires externally allocated pixel memory buffer and this buffer loses its ownershop by native DALi.
+ /// And this would make some problem, because dotnet runtime would change the address of memory allocated.
+ /// So this is required to be removed.
+ /// currently no use. will be added later
+ /// <since_tizen> 5 </since_tizen>
+ /// This will be released at Tizen.NET API Level 5, so currently this would be used as inhouse API.
+ [EditorBrowsable(EditorBrowsableState.Never)]
public class PixelData : BaseHandle
{
- private global::System.Runtime.InteropServices.HandleRef swigCPtr;
- internal PixelData(global::System.IntPtr cPtr, bool cMemoryOwn) : base(NDalicPINVOKE.PixelData_SWIGUpcast(cPtr), cMemoryOwn)
+ /// <summary>
+ /// Creates a PixelData object.
+ /// </summary>
+ /// <param name="buffer">The raw pixel data.</param>
+ /// <param name="bufferSize">The size of the buffer in bytes.</param>
+ /// <param name="width">Buffer width in pixels.</param>
+ /// <param name="height">Buffer height in pixels.</param>
+ /// <param name="pixelFormat">The pixel format.</param>
+ /// <param name="releaseFunction">The function used to release the memory.</param>
+ /// <since_tizen> 5 </since_tizen>
+ /// This will be released at Tizen.NET API Level 5, so currently this would be used as inhouse API.
+ [EditorBrowsable(EditorBrowsableState.Never)]
+ public PixelData(byte[] buffer, uint bufferSize, uint width, uint height, PixelFormat pixelFormat, PixelData.ReleaseFunction releaseFunction) : this(Interop.PixelData.New(buffer, bufferSize, width, height, (int)pixelFormat, (int)releaseFunction), true)
{
- swigCPtr = new global::System.Runtime.InteropServices.HandleRef(this, cPtr);
+ if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
+
}
- internal static global::System.Runtime.InteropServices.HandleRef getCPtr(PixelData obj)
+ internal PixelData(global::System.IntPtr cPtr, bool cMemoryOwn) : base(Interop.PixelData.Upcast(cPtr), cMemoryOwn)
{
- return (obj == null) ? new global::System.Runtime.InteropServices.HandleRef(null, global::System.IntPtr.Zero) : obj.swigCPtr;
}
- protected override void Dispose(DisposeTypes type)
+ /// <summary>
+ /// Enumeration for function to release the pixel buffer.
+ /// </summary>
+ /// <since_tizen> 5 </since_tizen>
+ /// This will be released at Tizen.NET API Level 5, so currently this would be used as inhouse API.
+ [EditorBrowsable(EditorBrowsableState.Never)]
+ public enum ReleaseFunction
{
- if (disposed)
- {
- return;
- }
-
- if (type == DisposeTypes.Explicit)
- {
- //Called by User
- //Release your own managed resources here.
- //You should release all of your own disposable objects here.
-
- }
-
- //Release your own unmanaged resources here.
- //You should not access any managed member here except static instance.
- //because the execution order of Finalizes is non-deterministic.
-
-
- if (swigCPtr.Handle != global::System.IntPtr.Zero)
- {
- if (swigCMemOwn)
- {
- swigCMemOwn = false;
- NDalicPINVOKE.delete_PixelData(swigCPtr);
- }
- swigCPtr = new global::System.Runtime.InteropServices.HandleRef(null, global::System.IntPtr.Zero);
- }
-
- base.Dispose(type);
+ /// <summary>
+ /// Use free function to release the pixel buffer.
+ /// </summary>
+ Free,
+
+ /// <summary>
+ /// Use delete[] operator to release the pixel buffer.
+ /// </summary>
+ DeleteArray
}
-
-
- public PixelData(byte[] buffer, uint bufferSize, uint width, uint height, PixelFormat pixelFormat, PixelData.ReleaseFunction releaseFunction) : this(NDalicPINVOKE.PixelData_New(buffer, bufferSize, width, height, (int)pixelFormat, (int)releaseFunction), true)
+ /// <summary>
+ /// Get URI from pixel data.
+ /// </summary>
+ [EditorBrowsable(EditorBrowsableState.Never)]
+ public Uri Uri
{
- if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
-
+ get
+ {
+ string Uri = "";
+ Uri = Interop.PixelData.GenerateUrl(this.SwigCPtr.Handle);
+ if (NDalicPINVOKE.SWIGPendingException.Pending) throw new InvalidOperationException("FATAL: get Exception", NDalicPINVOKE.SWIGPendingException.Retrieve());
+ return new Uri(Uri);
+ }
}
-
+ /// <summary>
+ /// Gets the width of the buffer in pixels.
+ /// </summary>
+ /// <returns>The width of the buffer in pixels.</returns>
+ /// <since_tizen> 5 </since_tizen>
+ /// This will be released at Tizen.NET API Level 5, so currently this would be used as inhouse API.
+ [EditorBrowsable(EditorBrowsableState.Never)]
public uint GetWidth()
{
- uint ret = NDalicPINVOKE.PixelData_GetWidth(swigCPtr);
+ uint ret = Interop.PixelData.GetWidth(SwigCPtr);
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
return ret;
}
+ /// <summary>
+ /// Gets the height of the buffer in pixels.
+ /// </summary>
+ /// <returns>The height of the buffer in pixels.</returns>
+ /// <since_tizen> 5 </since_tizen>
+ /// This will be released at Tizen.NET API Level 5, so currently this would be used as inhouse API.
+ [EditorBrowsable(EditorBrowsableState.Never)]
public uint GetHeight()
{
- uint ret = NDalicPINVOKE.PixelData_GetHeight(swigCPtr);
+ uint ret = Interop.PixelData.GetHeight(SwigCPtr);
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
return ret;
}
+ /// <summary>
+ /// Gets the pixel format.
+ /// </summary>
+ /// <returns>The pixel format.</returns>
+ /// <since_tizen> 5 </since_tizen>
+ /// This will be released at Tizen.NET API Level 5, so currently this would be used as inhouse API.
+ [EditorBrowsable(EditorBrowsableState.Never)]
public PixelFormat GetPixelFormat()
{
- PixelFormat ret = (PixelFormat)NDalicPINVOKE.PixelData_GetPixelFormat(swigCPtr);
+ PixelFormat ret = (PixelFormat)Interop.PixelData.GetPixelFormat(SwigCPtr);
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
return ret;
}
- public enum ReleaseFunction
+ internal static global::System.Runtime.InteropServices.HandleRef getCPtr(PixelData obj)
{
- FREE,
- DELETE_ARRAY
+ return (obj == null) ? new global::System.Runtime.InteropServices.HandleRef(null, global::System.IntPtr.Zero) : obj.SwigCPtr;
}
+ /// This will not be public opened.
+ [EditorBrowsable(EditorBrowsableState.Never)]
+ protected override void ReleaseSwigCPtr(System.Runtime.InteropServices.HandleRef swigCPtr)
+ {
+ Interop.PixelData.DeletePixelData(swigCPtr);
+ }
}
-
}
projects / platform / core / csapi / tizenfx.git / blobdiff