392 lines
15 KiB
XML
392 lines
15 KiB
XML
<?xml version="1.0"?>
|
|
<doc>
|
|
<assembly>
|
|
<name>StgSharp</name>
|
|
</assembly>
|
|
<members>
|
|
<member name="M:StgSharp.Instruction.InitPool">
|
|
<summary>
|
|
Add a pool to timeline controller, and return the instance of the pool.
|
|
</summary>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="F:StgSharp.Control.TimeLine.tickCounter">
|
|
<summary>
|
|
Tick counter count the frames passed since the program start.
|
|
</summary>
|
|
</member>
|
|
<member name="P:StgSharp.IEntity.CollisionSensor">
|
|
<summary>
|
|
A sensor used for cheking out if a bullet hit a player or something else
|
|
</summary>
|
|
</member>
|
|
<member name="P:StgSharp.IEntity.Location">
|
|
<summary>
|
|
A 2D vector presenting the position of an enemy entity, position can also be visited by X, Y
|
|
</summary>
|
|
</member>
|
|
<member name="P:StgSharp.IEntity.X">
|
|
<summary>
|
|
X position of an enenmy entity
|
|
</summary>
|
|
</member>
|
|
<member name="P:StgSharp.IEntity.Y">
|
|
<summary>
|
|
Y position of an enemy entity
|
|
</summary>
|
|
</member>
|
|
<member name="T:StgSharp.Geometries.UnusedVertexException">
|
|
<summary>
|
|
当几何体调用了过多的CalcVec方法时，产生UnusedVertexException异常
|
|
</summary>
|
|
</member>
|
|
<member name="T:StgSharp.Geometries.GetLocationHandler">
|
|
<summary>
|
|
计算位移失量，需要手动输入游戏刻以提供时间数据
|
|
</summary>
|
|
<param name="tickCounter"></param>
|
|
<returns>表示位移量的三维矢量</returns>
|
|
</member>
|
|
<member name="T:StgSharp.Geometries.IPlainGeometry">
|
|
<summary>
|
|
平面几何体。包含三角形，对称四边形，自由多边形等。最多可由16个点参数定义。
|
|
</summary>
|
|
</member>
|
|
<member name="M:StgSharp.Geometries.Parallelogram.MovVertex03(System.UInt32)">
|
|
<summary>
|
|
移动平行四边形的第三个顶点，是一个多余的方法，调用会引发多余变量异常
|
|
</summary>
|
|
<param name="tick">当前游戏刻</param>
|
|
<returns></returns>
|
|
<exception cref="T:StgSharp.Geometries.UnusedVertexException">几何体过定义</exception>
|
|
</member>
|
|
<member name="M:StgSharp.Geometries.Point.Update(System.UInt32)">
|
|
<summary>
|
|
Update the coordinate of the point. If this is a moving point,
|
|
(Points on sides or surface if other geometry items)
|
|
please do not define any motion here, codes will be ignored by program
|
|
</summary>
|
|
<param name="tick">Time passes since the program begin, counted by frames</param>
|
|
</member>
|
|
<member name="M:StgSharp.Geometries.Rectangle.MovCenter(System.UInt32)">
|
|
<summary>
|
|
计算中心点相对于参考原点的位移
|
|
</summary>
|
|
<param name="tick">当前游戏刻</param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="T:StgSharp.Geometries.Square">
|
|
<summary>
|
|
A square
|
|
</summary>
|
|
</member>
|
|
<member name="M:StgSharp.Graphics.Form.#ctor">
|
|
<summary>
|
|
Constructor of a Form, creats an instance of a form and
|
|
initilize all the customizing operations.
|
|
</summary>
|
|
</member>
|
|
<member name="M:StgSharp.Graphic.GLcreateWindow(System.Int32,System.Int32,System.Char[],System.IntPtr,System.IntPtr)">
|
|
<summary>
|
|
Creates a window and its associated context.
|
|
</summary>
|
|
<param name="width">Required width</param>
|
|
<param name="height">Required width</param>
|
|
<param name="tittle">Tittle of the window </param>
|
|
<param name="monitor"></param>
|
|
<param name="share"></param>
|
|
<returns>The handle of created window</returns>
|
|
<exception cref="T:System.Exception"></exception>
|
|
</member>
|
|
<member name="M:StgSharp.Graphic.GLcreateWindow(System.Int32,System.Int32,System.String,System.IntPtr,System.IntPtr)">
|
|
<summary>
|
|
Creates a window and its associated context.
|
|
</summary>
|
|
<param name="width">Required width</param>
|
|
<param name="height">Required width</param>
|
|
<param name="tittle">Tittle of the window </param>
|
|
<param name="monitor"></param>
|
|
<param name="share"></param>
|
|
<returns>The handle of created window</returns>
|
|
<exception cref="T:System.Exception"></exception>
|
|
</member>
|
|
<member name="M:StgSharp.Graphic.InitGL">
|
|
<summary>
|
|
Init an instance of OpenGL program,
|
|
This method should be called before other
|
|
graphic methods, after LoadGL method.
|
|
</summary>
|
|
</member>
|
|
<member name="M:StgSharp.Graphic.LoadGL">
|
|
<summary>
|
|
Load OpenGL API to StgSharp core programm,
|
|
please call this method before call any other
|
|
graphic APIs in StgSharp.
|
|
</summary>
|
|
<exception cref="T:System.Exception">If run this method twice, will throw exception</exception>
|
|
</member>
|
|
<member name="M:StgSharp.Graphic.LoadGLAD">
|
|
<summary>
|
|
Attach GLFW API to GLAD,
|
|
this method should be called after LoadGL
|
|
and before other graphic method.
|
|
</summary>
|
|
<exception cref="T:System.Exception">The accident that program cannot attach GLFW to GLAD</exception>
|
|
</member>
|
|
<member name="M:StgSharp.LinkedList`1.Add(`0)">
|
|
<summary>
|
|
Add an item to the tail of linked list.
|
|
</summary>
|
|
<param name="t">The item ready to add to the list</param>
|
|
</member>
|
|
<member name="M:StgSharp.Math.VectorCalc.multiple(StgSharp.Math.colum2,StgSharp.Math.vec2d)">
|
|
<summary>
|
|
|
|
</summary>
|
|
<param name="colum"></param>
|
|
<param name="vec"></param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:StgSharp.Math.VectorCalc.multiple(StgSharp.Math.vec2d,StgSharp.Math.vec2d)">
|
|
<summary>
|
|
|
|
</summary>
|
|
<param name="vec1"></param>
|
|
<param name="vec2"></param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:StgSharp.Math.VectorCalc.multiple(StgSharp.Math.vec2d,StgSharp.Math.colum2)">
|
|
<summary>
|
|
|
|
</summary>
|
|
<param name="vec"></param>
|
|
<param name="colum"></param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:StgSharp.Math.VectorCalc.multiple(StgSharp.Math.vec2d,StgSharp.Math.matrix2x2)">
|
|
<summary>
|
|
|
|
</summary>
|
|
<param name="vec"></param>
|
|
<param name="matrix"></param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:StgSharp.Math.VectorCalc.multiple(StgSharp.Math.vec2d,StgSharp.Math.matrix2x3)">
|
|
<summary>
|
|
|
|
</summary>
|
|
<param name="vec"></param>
|
|
<param name="matrix"></param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:StgSharp.Math.VectorCalc.multiple(StgSharp.Math.vec2d,StgSharp.Math.matrix2x4)">
|
|
<summary>
|
|
|
|
</summary>
|
|
<param name="vec"></param>
|
|
<param name="matrix"></param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:StgSharp.Math.VectorCalc.multiple(StgSharp.Math.matrix2x2,StgSharp.Math.colum2)">
|
|
<summary>
|
|
|
|
</summary>
|
|
<param name="matrix"></param>
|
|
<param name="colum"></param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:StgSharp.Math.VectorCalc.multiple(StgSharp.Math.matrix2x2,StgSharp.Math.matrix2x2)">
|
|
<summary>
|
|
|
|
</summary>
|
|
<param name="matrix1"></param>
|
|
<param name="matrix2"></param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:StgSharp.Math.VectorCalc.multiple(StgSharp.Math.matrix2x2,StgSharp.Math.matrix2x3)">
|
|
<summary>
|
|
|
|
</summary>
|
|
<param name="matrix1"></param>
|
|
<param name="matrix2"></param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:StgSharp.Math.VectorCalc.multiple(StgSharp.Math.matrix2x2,StgSharp.Math.matrix2x4)">
|
|
<summary>
|
|
|
|
</summary>
|
|
<param name="matrix1"></param>
|
|
<param name="matrix2"></param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:StgSharp.Math.VectorCalc.multiple(StgSharp.Math.matrix2x3,StgSharp.Math.colum3)">
|
|
<summary>
|
|
|
|
</summary>
|
|
<param name="matrix"></param>
|
|
<param name="vec"></param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:StgSharp.Math.VectorCalc.multiple(StgSharp.Math.matrix2x3,StgSharp.Math.matrix3x2)">
|
|
<summary>
|
|
|
|
</summary>
|
|
<param name="matrix1"></param>
|
|
<param name="matrix2"></param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:StgSharp.Math.VectorCalc.multiple(StgSharp.Math.matrix2x3,StgSharp.Math.matrix3x3)">
|
|
<summary>
|
|
|
|
</summary>
|
|
<param name="matrix1"></param>
|
|
<param name="matrix2"></param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:StgSharp.Math.VectorCalc.multiple(StgSharp.Math.matrix2x3,StgSharp.Math.matrix3x4)">
|
|
<summary>
|
|
|
|
</summary>
|
|
<param name="matrix1"></param>
|
|
<param name="matrix2"></param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:StgSharp.Math.VectorCalc.multiple(StgSharp.Math.matrix2x4,StgSharp.Math.matrix4x2)">
|
|
<summary>
|
|
|
|
</summary>
|
|
<param name="matrix1"></param>
|
|
<param name="matrix2"></param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:StgSharp.Math.VectorCalc.multiple(StgSharp.Math.matrix2x4,StgSharp.Math.matrix4x3)">
|
|
<summary>
|
|
|
|
</summary>
|
|
<param name="matrix1"></param>
|
|
<param name="matrix2"></param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:StgSharp.Math.VectorCalc.multiple(StgSharp.Math.matrix2x4,StgSharp.Math.matrix4x4)">
|
|
<summary>
|
|
|
|
</summary>
|
|
<param name="matrix1"></param>
|
|
<param name="matrix2"></param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:StgSharp.Math.VectorCalc.multiple(StgSharp.Math.matrix3x2,StgSharp.Math.matrix2x2)">
|
|
<summary>
|
|
|
|
</summary>
|
|
<param name="matrix1"></param>
|
|
<param name="matrix2"></param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:StgSharp.Math.VectorCalc.multiple(StgSharp.Math.matrix3x2,StgSharp.Math.matrix2x3)">
|
|
<summary>
|
|
|
|
</summary>
|
|
<param name="matrix1"></param>
|
|
<param name="matrix2"></param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:StgSharp.Math.VectorCalc.multiple(StgSharp.Math.matrix3x2,StgSharp.Math.matrix2x4)">
|
|
<summary>
|
|
|
|
</summary>
|
|
<param name="matrix1"></param>
|
|
<param name="matrix2"></param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:StgSharp.Math.VectorCalc.multiple(StgSharp.Math.matrix3x3,StgSharp.Math.matrix3x2)">
|
|
<summary>
|
|
|
|
</summary>
|
|
<param name="matrix1"></param>
|
|
<param name="matrix2"></param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:StgSharp.Math.VectorCalc.multiple(StgSharp.Math.matrix3x3,StgSharp.Math.matrix3x3)">
|
|
<summary>
|
|
|
|
</summary>
|
|
<param name="matrix1"></param>
|
|
<param name="matrix2"></param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:StgSharp.Math.VectorCalc.multiple(StgSharp.Math.matrix3x4,StgSharp.Math.matrix4x2)">
|
|
<summary>
|
|
|
|
</summary>
|
|
<param name="matrix1"></param>
|
|
<param name="matrix2"></param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:StgSharp.Math.VectorCalc.multiple(StgSharp.Math.matrix3x4,StgSharp.Math.matrix4x3)">
|
|
<summary>
|
|
|
|
</summary>
|
|
<param name="matrix1"></param>
|
|
<param name="matrix2"></param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:StgSharp.Math.VectorCalc.multiple(StgSharp.Math.matrix3x4,StgSharp.Math.matrix4x4)">
|
|
<summary>
|
|
|
|
</summary>
|
|
<param name="matrix1"></param>
|
|
<param name="matrix2"></param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:StgSharp.Math.VectorCalc.multiple(StgSharp.Math.matrix4x2,StgSharp.Math.matrix2x4)">
|
|
<summary>
|
|
|
|
</summary>
|
|
<param name="matrix1"></param>
|
|
<param name="matrix2"></param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:StgSharp.Math.VectorCalc.multiple(StgSharp.Math.matrix4x4,StgSharp.Math.matrix4x4)">
|
|
<summary>
|
|
|
|
</summary>
|
|
<param name="matrix1"></param>
|
|
<param name="matrix2"></param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:StgSharp.Math.Calc.ASin(System.Single)">
|
|
<summary>
|
|
Reurns the value of ArcSin(x)
|
|
</summary>
|
|
<param name="x">The sine value of the angle</param>
|
|
<returns></returns>
|
|
<exception cref="T:System.ArgumentException"></exception>
|
|
</member>
|
|
<member name="M:StgSharp.Math.Calc.Exp(System.Single)">
|
|
<summary>
|
|
Get the value of E ^ x;
|
|
</summary>
|
|
<param name="x"></param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:StgSharp.Math.Calc.Log(System.Single)">
|
|
<summary>
|
|
|
|
</summary>
|
|
<param name="x"></param>
|
|
<returns>
|
|
Returns the value of ln(x).
|
|
</returns>
|
|
</member>
|
|
<member name="M:StgSharp.Math.Calc.Pow(System.Single,System.Single)">
|
|
<summary>
|
|
calculate the value of x^y
|
|
</summary>
|
|
<param name="x"></param>
|
|
<param name="y"></param>
|
|
<returns>Returns the value of x^y</returns>
|
|
</member>
|
|
</members>
|
|
</doc>
|