Skip to content
Snippets Groups Projects
SharpDX.Mathematics.xml 858 KiB
Newer Older
SCHAAL CESAR's avatar
SCHAAL CESAR committed
16001 16002 16003 16004 16005 16006 16007 16008 16009 16010 16011 16012 16013 16014 16015 16016 16017 16018 16019 16020 16021 16022 16023 16024 16025 16026 16027 16028 16029 16030 16031 16032 16033 16034 16035 16036 16037 16038 16039 16040 16041 16042 16043 16044 16045 16046 16047 16048 16049 16050 16051 16052 16053 16054 16055 16056 16057 16058 16059 16060 16061 16062 16063 16064 16065 16066 16067 16068 16069 16070 16071 16072 16073 16074 16075 16076 16077 16078 16079 16080 16081 16082 16083 16084 16085 16086 16087 16088 16089 16090 16091 16092 16093 16094 16095 16096 16097 16098 16099 16100 16101 16102 16103 16104 16105 16106 16107 16108 16109 16110 16111 16112 16113 16114 16115 16116 16117 16118 16119 16120 16121 16122 16123 16124 16125 16126 16127 16128 16129 16130 16131 16132 16133 16134 16135 16136 16137 16138 16139 16140 16141 16142 16143 16144 16145 16146 16147 16148 16149 16150 16151 16152 16153 16154 16155 16156 16157 16158 16159 16160 16161 16162 16163 16164 16165 16166 16167 16168 16169 16170 16171 16172 16173 16174 16175 16176 16177 16178 16179 16180 16181 16182 16183 16184 16185 16186 16187 16188 16189 16190 16191 16192 16193 16194 16195 16196 16197 16198 16199 16200 16201 16202 16203 16204 16205 16206 16207 16208 16209 16210 16211 16212 16213 16214 16215 16216 16217 16218 16219 16220 16221 16222 16223 16224 16225 16226 16227 16228 16229 16230 16231 16232 16233 16234 16235 16236 16237 16238 16239 16240 16241 16242 16243 16244 16245 16246 16247 16248 16249 16250 16251 16252 16253 16254 16255 16256 16257 16258 16259 16260 16261 16262 16263 16264 16265 16266 16267 16268 16269 16270 16271 16272 16273 16274 16275 16276 16277 16278 16279 16280 16281 16282 16283 16284 16285 16286 16287 16288 16289 16290 16291 16292 16293 16294 16295 16296 16297 16298 16299 16300 16301 16302 16303 16304 16305 16306 16307 16308 16309 16310 16311 16312 16313 16314 16315 16316 16317 16318 16319 16320 16321 16322 16323 16324 16325 16326 16327 16328 16329 16330 16331 16332 16333 16334 16335 16336 16337 16338 16339 16340 16341 16342 16343 16344 16345 16346 16347 16348 16349 16350 16351 16352 16353 16354 16355 16356 16357 16358 16359 16360 16361 16362 16363 16364 16365 16366 16367 16368 16369 16370 16371 16372 16373 16374 16375 16376 16377 16378 16379 16380 16381 16382 16383 16384 16385 16386 16387 16388 16389 16390 16391 16392 16393 16394 16395 16396
            </summary>
            <param name="other">The <see cref="T:SharpDX.Vector4"/> to compare with this instance.</param>
            <returns>
            <c>true</c> if the specified <see cref="T:SharpDX.Vector4"/> is equal to this instance; otherwise, <c>false</c>.
            </returns>
        </member>
        <member name="M:SharpDX.Vector4.Equals(System.Object)">
            <summary>
            Determines whether the specified <see cref="T:System.Object"/> is equal to this instance.
            </summary>
            <param name="value">The <see cref="T:System.Object"/> to compare with this instance.</param>
            <returns>
            <c>true</c> if the specified <see cref="T:System.Object"/> is equal to this instance; otherwise, <c>false</c>.
            </returns>
        </member>
        <member name="M:SharpDX.Vector4.op_Implicit(SharpDX.Vector4)~SharpDX.Mathematics.Interop.RawVector4">
            <summary>
            Performs an implicit conversion from <see cref="T:SharpDX.Vector4"/> to <see cref="T:SharpDX.Mathematics.Interop.RawVector4"/>.
            </summary>
            <param name="value">The value.</param>
            <returns>The result of the conversion.</returns>
        </member>
        <member name="M:SharpDX.Vector4.op_Implicit(SharpDX.Mathematics.Interop.RawVector4)~SharpDX.Vector4">
            <summary>
            Performs an implicit conversion from <see cref="T:SharpDX.Mathematics.Interop.RawVector4"/> to <see cref="T:SharpDX.Vector4"/>.
            </summary>
            <param name="value">The value.</param>
            <returns>The result of the conversion.</returns>
        </member>
        <member name="T:SharpDX.Viewport">
            <summary>
            Defines the viewport dimensions.
            </summary>
        </member>
        <member name="F:SharpDX.Viewport.X">
            <summary>
            Position of the pixel coordinate of the upper-left corner of the viewport.
            </summary>
        </member>
        <member name="F:SharpDX.Viewport.Y">
            <summary>
            Position of the pixel coordinate of the upper-left corner of the viewport.
            </summary>
        </member>
        <member name="F:SharpDX.Viewport.Width">
            <summary>
            Width dimension of the viewport.
            </summary>
        </member>
        <member name="F:SharpDX.Viewport.Height">
            <summary>
            Height dimension of the viewport.
            </summary>
        </member>
        <member name="F:SharpDX.Viewport.MinDepth">
            <summary>
            Gets or sets the minimum depth of the clip volume.
            </summary>
        </member>
        <member name="F:SharpDX.Viewport.MaxDepth">
            <summary>
            Gets or sets the maximum depth of the clip volume.
            </summary>
        </member>
        <member name="M:SharpDX.Viewport.#ctor(System.Int32,System.Int32,System.Int32,System.Int32)">
            <summary>
            Initializes a new instance of the <see cref="T:SharpDX.Viewport"/> struct.
            </summary>
            <param name="x">The x coordinate of the upper-left corner of the viewport in pixels.</param>
            <param name="y">The y coordinate of the upper-left corner of the viewport in pixels.</param>
            <param name="width">The width of the viewport in pixels.</param>
            <param name="height">The height of the viewport in pixels.</param>
        </member>
        <member name="M:SharpDX.Viewport.#ctor(System.Int32,System.Int32,System.Int32,System.Int32,System.Single,System.Single)">
            <summary>
            Initializes a new instance of the <see cref="T:SharpDX.Viewport"/> struct.
            </summary>
            <param name="x">The x coordinate of the upper-left corner of the viewport in pixels.</param>
            <param name="y">The y coordinate of the upper-left corner of the viewport in pixels.</param>
            <param name="width">The width of the viewport in pixels.</param>
            <param name="height">The height of the viewport in pixels.</param>
            <param name="minDepth">The minimum depth of the clip volume.</param>
            <param name="maxDepth">The maximum depth of the clip volume.</param>
        </member>
        <member name="M:SharpDX.Viewport.#ctor(SharpDX.Rectangle)">
            <summary>
            Initializes a new instance of the <see cref="T:SharpDX.Viewport"/> struct.
            </summary>
            <param name="bounds">A bounding box that defines the location and size of the viewport in a render target.</param>
        </member>
        <member name="P:SharpDX.Viewport.Bounds">
            <summary>
            Gets the size of this resource.
            </summary>
            <value>The bounds.</value>
        </member>
        <member name="M:SharpDX.Viewport.Equals(SharpDX.Viewport@)">
            <summary>
            Determines whether the specified <see cref="T:SharpDX.Viewport"/> is equal to this instance.
            </summary>
            <param name="other">The <see cref="T:SharpDX.Viewport"/> to compare with this instance.</param>
            <returns>
            <c>true</c> if the specified <see cref="T:SharpDX.Viewport"/> is equal to this instance; otherwise, <c>false</c>.
            </returns>
        </member>
        <member name="M:SharpDX.Viewport.Equals(SharpDX.Viewport)">
            <summary>
            Determines whether the specified <see cref="T:SharpDX.Viewport"/> is equal to this instance.
            </summary>
            <param name="other">The <see cref="T:SharpDX.Viewport"/> to compare with this instance.</param>
            <returns>
            <c>true</c> if the specified <see cref="T:SharpDX.Viewport"/> is equal to this instance; otherwise, <c>false</c>.
            </returns>
        </member>
        <member name="M:SharpDX.Viewport.Equals(System.Object)">
            <summary>
            Determines whether the specified object is equal to this instance.
            </summary>
            <param name="obj">The object to compare with this instance.</param>
            <returns>
            <c>true</c> if the specified object is equal to this instance; otherwise, <c>false</c>.
            </returns>
        </member>
        <member name="M:SharpDX.Viewport.GetHashCode">
            <summary>
            Returns a hash code for this instance.
            </summary>
            <returns>
            A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table. 
            </returns>
        </member>
        <member name="M:SharpDX.Viewport.op_Equality(SharpDX.Viewport,SharpDX.Viewport)">
            <summary>
            Implements the operator ==.
            </summary>
            <param name="left">The left.</param>
            <param name="right">The right.</param>
            <returns>The result of the operator.</returns>
        </member>
        <member name="M:SharpDX.Viewport.op_Inequality(SharpDX.Viewport,SharpDX.Viewport)">
            <summary>
            Implements the operator !=.
            </summary>
            <param name="left">The left.</param>
            <param name="right">The right.</param>
            <returns>The result of the operator.</returns>
        </member>
        <member name="M:SharpDX.Viewport.ToString">
            <summary>
            Retrieves a string representation of this object.
            </summary>
            <returns>A <see cref="T:System.String" /> that represents this instance.</returns>
        </member>
        <member name="M:SharpDX.Viewport.Project(SharpDX.Vector3,SharpDX.Matrix,SharpDX.Matrix,SharpDX.Matrix)">
            <summary>
            Projects a 3D vector from object space into screen space.
            </summary>
            <param name="source">The vector to project.</param>
            <param name="projection">The projection matrix.</param>
            <param name="view">The view matrix.</param>
            <param name="world">The world matrix.</param>
            <returns>The projected vector.</returns>
        </member>
        <member name="M:SharpDX.Viewport.Project(SharpDX.Vector3@,SharpDX.Matrix@,SharpDX.Vector3@)">
            <summary>
            Projects a 3D vector from object space into screen space.
            </summary>
            <param name="source">The vector to project.</param>
            <param name="matrix">A combined WorldViewProjection matrix.</param>
            <param name="vector">The projected vector.</param>
        </member>
        <member name="M:SharpDX.Viewport.Unproject(SharpDX.Vector3,SharpDX.Matrix,SharpDX.Matrix,SharpDX.Matrix)">
            <summary>
            Converts a screen space point into a corresponding point in world space.
            </summary>
            <param name="source">The vector to project.</param>
            <param name="projection">The projection matrix.</param>
            <param name="view">The view matrix.</param>
            <param name="world">The world matrix.</param>
            <returns>The unprojected Vector.</returns>
        </member>
        <member name="M:SharpDX.Viewport.Unproject(SharpDX.Vector3@,SharpDX.Matrix@,SharpDX.Vector3@)">
            <summary>
            Converts a screen space point into a corresponding point in world space.
            </summary>
            <param name="source">The vector to project.</param>
            <param name="matrix">An inverted combined WorldViewProjection matrix.</param>
            <param name="vector">The unprojected vector.</param>
        </member>
        <member name="P:SharpDX.Viewport.AspectRatio">
            <summary>
            Gets the aspect ratio used by the viewport.
            </summary>
            <value>The aspect ratio.</value>
        </member>
        <member name="M:SharpDX.Viewport.op_Implicit(SharpDX.Viewport)~SharpDX.Mathematics.Interop.RawViewport">
            <summary>
            Performs an implicit conversion from <see cref="T:SharpDX.Viewport"/> to <see cref="T:SharpDX.Mathematics.Interop.RawViewport"/>.
            </summary>
            <param name="value">The value.</param>
            <returns>The result of the conversion.</returns>
        </member>
        <member name="M:SharpDX.Viewport.op_Implicit(SharpDX.Viewport)~SharpDX.Mathematics.Interop.RawViewportF">
            <summary>
            Performs an implicit conversion from <see cref="T:SharpDX.Viewport"/> to <see cref="T:SharpDX.Mathematics.Interop.RawViewport"/>.
            </summary>
            <param name="value">The value.</param>
            <returns>The result of the conversion.</returns>
        </member>
        <member name="M:SharpDX.Viewport.op_Implicit(SharpDX.Mathematics.Interop.RawViewport)~SharpDX.Viewport">
            <summary>
            Performs an implicit conversion from <see cref="T:SharpDX.Mathematics.Interop.RawViewport"/> to <see cref="T:SharpDX.Viewport"/>.
            </summary>
            <param name="value">The value.</param>
            <returns>The result of the conversion.</returns>
        </member>
        <member name="T:SharpDX.ViewportF">
            <summary>
            Defines the viewport dimensions using float coordinates for (X,Y,Width,Height).
            </summary>
        </member>
        <member name="F:SharpDX.ViewportF.X">
            <summary>
            Position of the pixel coordinate of the upper-left corner of the viewport.
            </summary>
        </member>
        <member name="F:SharpDX.ViewportF.Y">
            <summary>
            Position of the pixel coordinate of the upper-left corner of the viewport.
            </summary>
        </member>
        <member name="F:SharpDX.ViewportF.Width">
            <summary>
            Width dimension of the viewport.
            </summary>
        </member>
        <member name="F:SharpDX.ViewportF.Height">
            <summary>
            Height dimension of the viewport.
            </summary>
        </member>
        <member name="F:SharpDX.ViewportF.MinDepth">
            <summary>
            Gets or sets the minimum depth of the clip volume.
            </summary>
        </member>
        <member name="F:SharpDX.ViewportF.MaxDepth">
            <summary>
            Gets or sets the maximum depth of the clip volume.
            </summary>
        </member>
        <member name="M:SharpDX.ViewportF.#ctor(System.Single,System.Single,System.Single,System.Single)">
            <summary>
            Initializes a new instance of the <see cref="T:SharpDX.ViewportF"/> struct.
            </summary>
            <param name="x">The x coordinate of the upper-left corner of the viewport in pixels.</param>
            <param name="y">The y coordinate of the upper-left corner of the viewport in pixels.</param>
            <param name="width">The width of the viewport in pixels.</param>
            <param name="height">The height of the viewport in pixels.</param>
        </member>
        <member name="M:SharpDX.ViewportF.#ctor(System.Single,System.Single,System.Single,System.Single,System.Single,System.Single)">
            <summary>
            Initializes a new instance of the <see cref="T:SharpDX.ViewportF"/> struct.
            </summary>
            <param name="x">The x coordinate of the upper-left corner of the viewport in pixels.</param>
            <param name="y">The y coordinate of the upper-left corner of the viewport in pixels.</param>
            <param name="width">The width of the viewport in pixels.</param>
            <param name="height">The height of the viewport in pixels.</param>
            <param name="minDepth">The minimum depth of the clip volume.</param>
            <param name="maxDepth">The maximum depth of the clip volume.</param>
        </member>
        <member name="M:SharpDX.ViewportF.#ctor(SharpDX.RectangleF)">
            <summary>
            Initializes a new instance of the <see cref="T:SharpDX.ViewportF"/> struct.
            </summary>
            <param name="bounds">A bounding box that defines the location and size of the viewport in a render target.</param>
        </member>
        <member name="P:SharpDX.ViewportF.Bounds">
            <summary>
            Gets the size of this resource.
            </summary>
            <value>The bounds.</value>
        </member>
        <member name="M:SharpDX.ViewportF.Equals(SharpDX.ViewportF@)">
            <summary>
            Determines whether the specified <see cref="T:SharpDX.ViewportF"/> is equal to this instance.
            </summary>
            <param name="other">The <see cref="T:SharpDX.ViewportF"/> to compare with this instance.</param>
            <returns>
            <c>true</c> if the specified <see cref="T:SharpDX.ViewportF"/> is equal to this instance; otherwise, <c>false</c>.
            </returns>
        </member>
        <member name="M:SharpDX.ViewportF.Equals(SharpDX.ViewportF)">
            <summary>
            Determines whether the specified <see cref="T:SharpDX.ViewportF"/> is equal to this instance.
            </summary>
            <param name="other">The <see cref="T:SharpDX.ViewportF"/> to compare with this instance.</param>
            <returns>
            <c>true</c> if the specified <see cref="T:SharpDX.ViewportF"/> is equal to this instance; otherwise, <c>false</c>.
            </returns>
        </member>
        <member name="M:SharpDX.ViewportF.Equals(System.Object)">
            <summary>
            Determines whether the specified object is equal to this instance.
            </summary>
            <param name="obj">The object to compare with this instance.</param>
            <returns>
            <c>true</c> if the specified object is equal to this instance; otherwise, <c>false</c>.
            </returns>
        </member>
        <member name="M:SharpDX.ViewportF.GetHashCode">
            <summary>
            Returns a hash code for this instance.
            </summary>
            <returns>
            A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table. 
            </returns>
        </member>
        <member name="M:SharpDX.ViewportF.op_Equality(SharpDX.ViewportF,SharpDX.ViewportF)">
            <summary>
            Implements the operator ==.
            </summary>
            <param name="left">The left.</param>
            <param name="right">The right.</param>
            <returns>The result of the operator.</returns>
        </member>
        <member name="M:SharpDX.ViewportF.op_Inequality(SharpDX.ViewportF,SharpDX.ViewportF)">
            <summary>
            Implements the operator !=.
            </summary>
            <param name="left">The left.</param>
            <param name="right">The right.</param>
            <returns>The result of the operator.</returns>
        </member>
        <member name="M:SharpDX.ViewportF.ToString">
            <summary>
            Retrieves a string representation of this object.
            </summary>
            <returns>A <see cref="T:System.String"/> that represents this instance.</returns>
        </member>
        <!-- Badly formed XML comment ignored for member "M:SharpDX.ViewportF.Project(SharpDX.Vector3,SharpDX.Matrix,SharpDX.Matrix,SharpDX.Matrix)" -->
        <member name="M:SharpDX.ViewportF.Project(SharpDX.Vector3@,SharpDX.Matrix@,SharpDX.Vector3@)">
            <summary>
            Projects a 3D vector from object space into screen space.
            </summary>
            <param name="source">The vector to project.</param>
            <param name="matrix">A combined WorldViewProjection matrix.</param>
            <param name="vector">The projected vector.</param>
        </member>
        <member name="M:SharpDX.ViewportF.Unproject(SharpDX.Vector3,SharpDX.Matrix,SharpDX.Matrix,SharpDX.Matrix)">
            <summary>
            Converts a screen space point into a corresponding point in world space.
            </summary>
            <param name="source">The vector to project.</param>
            <param name="projection">The projection matrix.</param>
            <param name="view">The view matrix.</param>
            <param name="world">The world matrix.</param>
            <returns>The unprojected Vector.</returns>
        </member>
        <member name="M:SharpDX.ViewportF.Unproject(SharpDX.Vector3@,SharpDX.Matrix@,SharpDX.Vector3@)">
            <summary>
            Converts a screen space point into a corresponding point in world space.
            </summary>
            <param name="source">The vector to project.</param>
            <param name="matrix">An inverted combined WorldViewProjection matrix.</param>
            <param name="vector">The unprojected vector.</param>
        </member>
        <member name="P:SharpDX.ViewportF.AspectRatio">
            <summary>
            Gets the aspect ratio used by the viewport.
            </summary>
            <value>The aspect ratio.</value>
        </member>
        <member name="M:SharpDX.ViewportF.op_Implicit(SharpDX.Viewport)~SharpDX.ViewportF">
            <summary>
            Performs an explicit conversion from <see cref="T:SharpDX.Viewport"/> to <see cref="T:SharpDX.ViewportF"/>.
            </summary>
            <param name="value">The value.</param>
            <returns>The result of the conversion.</returns>
        </member>
        <member name="M:SharpDX.ViewportF.op_Implicit(SharpDX.ViewportF)~SharpDX.Mathematics.Interop.RawViewportF">
            <summary>
            Performs an implicit conversion from <see cref="T:SharpDX.ViewportF"/> to <see cref="T:SharpDX.Mathematics.Interop.RawViewportF"/>.
            </summary>
            <param name="value">The value.</param>
            <returns>The result of the conversion.</returns>
        </member>
        <member name="M:SharpDX.ViewportF.op_Implicit(SharpDX.Mathematics.Interop.RawViewportF)~SharpDX.ViewportF">
            <summary>
            Performs an implicit conversion from <see cref="T:SharpDX.Mathematics.Interop.RawViewportF"/> to <see cref="T:SharpDX.ViewportF"/>.
            </summary>
            <param name="value">The value.</param>
            <returns>The result of the conversion.</returns>
        </member>
    </members>
</doc>