urho3d.UrhoSharp/docs/Urho/VectorBase.xml

<Type Name="VectorBase" FullName="Urho.VectorBase">
  <TypeSignature Language="C#" Value="public struct VectorBase" />
  <TypeSignature Language="ILAsm" Value=".class public sequential ansi sealed beforefieldinit VectorBase extends System.ValueType" />
  <AssemblyInfo>
    <AssemblyName>Urho</AssemblyName>
    <AssemblyVersion>1.0.0.0</AssemblyVersion>
  </AssemblyInfo>
  <Base>
    <BaseTypeName>System.ValueType</BaseTypeName>
  </Base>
  <Interfaces />
  <Docs>
    <summary>Represents a vector that can be retrieved in different formats.</summary>
    <remarks>When you have a VectorBase, you can retrieve the data pointed to by the buffer with the given size into a managed array by invoking the generic ToArray method.</remarks>
  </Docs>
  <Members>
    <Member MemberName="Buffer">
      <MemberSignature Language="C#" Value="public IntPtr Buffer;" />
      <MemberSignature Language="ILAsm" Value=".field public native int Buffer" />
      <MemberType>Field</MemberType>
      <AssemblyInfo>
        <AssemblyVersion>1.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.IntPtr</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>Pointer to the buffer holding the vector data.</summary>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="Capacity">
      <MemberSignature Language="C#" Value="public uint Capacity;" />
      <MemberSignature Language="ILAsm" Value=".field public unsigned int32 Capacity" />
      <MemberType>Field</MemberType>
      <AssemblyInfo>
        <AssemblyVersion>1.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.UInt32</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>Capacity for the vector</summary>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="Size">
      <MemberSignature Language="C#" Value="public uint Size;" />
      <MemberSignature Language="ILAsm" Value=".field public unsigned int32 Size" />
      <MemberType>Field</MemberType>
      <AssemblyInfo>
        <AssemblyVersion>1.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.UInt32</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>The current size of the vector.</summary>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="ToArray&lt;T&gt;">
      <MemberSignature Language="C#" Value="public T[] ToArray&lt;T&gt; () where T : struct;" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig instance !!T[] ToArray&lt;struct .ctor (class System.ValueType) T&gt;() cil managed" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyVersion>1.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>T[]</ReturnType>
      </ReturnValue>
      <TypeParameters>
        <TypeParameter Name="T">
          <Constraints>
            <ParameterAttribute>DefaultConstructorConstraint</ParameterAttribute>
            <ParameterAttribute>NotNullableValueTypeConstraint</ParameterAttribute>
            <BaseTypeName>System.ValueType</BaseTypeName>
          </Constraints>
        </TypeParameter>
      </TypeParameters>
      <Parameters />
      <Docs>
        <typeparam name="T">To be added.</typeparam>
        <summary>Retrieves up to Size elemenst from the location in memory pointed at by Buffer and casts each individual member into a type of T.</summary>
        <returns>To be added.</returns>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
  </Members>
</Type>