TiltFive.T5_StringUTF8 Struct Reference

Represents a string value. More...

Inheritance diagram for TiltFive.T5_StringUTF8:

Public Member Functions
	T5_StringUTF8 (string text)
void	Dispose ()
	Safely disposes of this T5_StringUTF8 and any unmanaged memory allocated during its construction.

Static Public Member Functions
static implicit	operator string (T5_StringUTF8 t5_StringUTF8)
static implicit	operator T5_StringUTF8 (string text)

Static Private Member Functions
static string	ToString (T5_StringUTF8 t5_StringUTF8)

Private Attributes
UInt32	maxBufferSize
UInt32	length
IntPtr	pStringBytesUTF8

Detailed Description

Represents a string value.

This struct exists primarily to guarantee a common memory layout when marshaling string values to/from the native plugin. Note that it implements IDisposable, and that it should be wrapped in a "using" statement/block to avoid leaking memory.

Definition at line 410 of file NativePlugin.cs.

Constructor & Destructor Documentation

T5_StringUTF8()

TiltFive.T5_StringUTF8.T5_StringUTF8

(

string

text

)

Definition at line 416 of file NativePlugin.cs.

        {
            pStringBytesUTF8 = IntPtr.Zero;
            length = 0;
            maxBufferSize = 16 * 1024;
 
            if (text != null)
            {
                // Allocate enough unmanaged memory to store the string
                byte[] textBytesUTF8 = System.Text.Encoding.UTF8.GetBytes(text);
 
                // If the string is too long to fit in the unmanaged buffer, truncate it.
                length = (UInt32)Math.Min(textBytesUTF8.Length, maxBufferSize);
                pStringBytesUTF8 = Marshal.AllocHGlobal((int)maxBufferSize);
 
                // Store the string data
                Marshal.Copy(textBytesUTF8, 0, pStringBytesUTF8, (int)length);
            }
        }

References TiltFive.T5_StringUTF8.length, TiltFive.T5_StringUTF8.maxBufferSize, and TiltFive.T5_StringUTF8.pStringBytesUTF8.

Member Function Documentation

Dispose()

void TiltFive.T5_StringUTF8.Dispose

(

)

Safely disposes of this T5_StringUTF8 and any unmanaged memory allocated during its construction.

Definition at line 464 of file NativePlugin.cs.

        {
            // Don't forget to free that unmanaged memory we allocated.
            // Marshal.FreeHGlobal() will safely do nothing if IntPtr.Zero is passed in.
            Marshal.FreeHGlobal(pStringBytesUTF8);
            pStringBytesUTF8 = IntPtr.Zero;
        }

References TiltFive.T5_StringUTF8.pStringBytesUTF8.

Referenced by TiltFive.Glasses.GlassesCore.TryGetFriendlyName().

operator string()

static implicit TiltFive.T5_StringUTF8.operator string ( T5_StringUTF8  t5_StringUTF8 )

static

operator T5_StringUTF8()

static implicit TiltFive.T5_StringUTF8.operator T5_StringUTF8 ( string  text )

static

ToString()

static string TiltFive.T5_StringUTF8.ToString ( T5_StringUTF8  t5_StringUTF8 )

staticprivate

Definition at line 441 of file NativePlugin.cs.

        {
            if (t5_StringUTF8.pStringBytesUTF8 == IntPtr.Zero)
            {
                return null;
            }
 
            var managedBytes = new byte[t5_StringUTF8.length];
            try
            {
                Marshal.Copy(t5_StringUTF8.pStringBytesUTF8, managedBytes, 0, (int)t5_StringUTF8.length);
                return System.Text.Encoding.UTF8.GetString(managedBytes);
            }
            catch (Exception e)
            {
                Debug.LogError($"Failed to copy string from unmanaged memory: {e}");
                return null;
            }
        }

References TiltFive.T5_StringUTF8.length, and TiltFive.T5_StringUTF8.pStringBytesUTF8.

Member Data Documentation

length

UInt32 TiltFive.T5_StringUTF8.length

private

Definition at line 413 of file NativePlugin.cs.

Referenced by TiltFive.T5_StringUTF8.T5_StringUTF8(), and TiltFive.T5_StringUTF8.ToString().

maxBufferSize

UInt32 TiltFive.T5_StringUTF8.maxBufferSize

private

Definition at line 412 of file NativePlugin.cs.

Referenced by TiltFive.T5_StringUTF8.T5_StringUTF8().

pStringBytesUTF8

IntPtr TiltFive.T5_StringUTF8.pStringBytesUTF8

private

Definition at line 414 of file NativePlugin.cs.

Referenced by TiltFive.T5_StringUTF8.Dispose(), TiltFive.T5_StringUTF8.T5_StringUTF8(), and TiltFive.T5_StringUTF8.ToString().

---

The documentation for this struct was generated from the following file:

• NativePlugin.cs