A game about forced loneliness, made by TACStudios
1<?xml version="1.0"?>
2<doc>
3 <assembly>
4 <name>System.Runtime.CompilerServices.Unsafe</name>
5 </assembly>
6 <members>
7 <member name="T:System.Runtime.CompilerServices.Unsafe">
8 <summary>
9 Contains generic, low-level functionality for manipulating pointers.
10 </summary>
11 </member>
12 <member name="M:System.Runtime.CompilerServices.Unsafe.Read``1(System.Void*)">
13 <summary>
14 Reads a value of type <typeparamref name="T"/> from the given location.
15 </summary>
16 <typeparam name="T">The type to read.</typeparam>
17 <param name="source">The location to read from.</param>
18 <returns>An object of type <typeparamref name="T"/> read from the given location.</returns>
19 </member>
20 <member name="M:System.Runtime.CompilerServices.Unsafe.ReadUnaligned``1(System.Void*)">
21 <summary>
22 Reads a value of type <typeparamref name="T"/> from the given location.
23 </summary>
24 <typeparam name="T">The type to read.</typeparam>
25 <param name="source">The location to read from.</param>
26 <returns>An object of type <typeparamref name="T"/> read from the given location.</returns>
27 </member>
28 <member name="M:System.Runtime.CompilerServices.Unsafe.ReadUnaligned``1(System.Byte@)">
29 <summary>
30 Reads a value of type <typeparamref name="T"/> from the given location.
31 </summary>
32 <typeparam name="T">The type to read.</typeparam>
33 <param name="source">The location to read from.</param>
34 <returns>An object of type <typeparamref name="T"/> read from the given location.</returns>
35 </member>
36 <member name="M:System.Runtime.CompilerServices.Unsafe.Write``1(System.Void*,``0)">
37 <summary>
38 Writes a value of type <typeparamref name="T"/> to the given location.
39 </summary>
40 <typeparam name="T">The type of value to write.</typeparam>
41 <param name="destination">The location to write to.</param>
42 <param name="value">The value to write.</param>
43 </member>
44 <member name="M:System.Runtime.CompilerServices.Unsafe.WriteUnaligned``1(System.Void*,``0)">
45 <summary>
46 Writes a value of type <typeparamref name="T"/> to the given location.
47 </summary>
48 <typeparam name="T">The type of value to write.</typeparam>
49 <param name="destination">The location to write to.</param>
50 <param name="value">The value to write.</param>
51 </member>
52 <member name="M:System.Runtime.CompilerServices.Unsafe.WriteUnaligned``1(System.Byte@,``0)">
53 <summary>
54 Writes a value of type <typeparamref name="T"/> to the given location.
55 </summary>
56 <typeparam name="T">The type of value to write.</typeparam>
57 <param name="destination">The location to write to.</param>
58 <param name="value">The value to write.</param>
59 </member>
60 <member name="M:System.Runtime.CompilerServices.Unsafe.Copy``1(System.Void*,``0@)">
61 <summary>
62 Copies a value of type <typeparamref name="T"/> to the given location.
63 </summary>
64 <typeparam name="T">The type of value to copy.</typeparam>
65 <param name="destination">The location to copy to.</param>
66 <param name="source">A reference to the value to copy.</param>
67 </member>
68 <member name="M:System.Runtime.CompilerServices.Unsafe.Copy``1(``0@,System.Void*)">
69 <summary>
70 Copies a value of type <typeparamref name="T"/> to the given location.
71 </summary>
72 <typeparam name="T">The type of value to copy.</typeparam>
73 <param name="destination">The location to copy to.</param>
74 <param name="source">A pointer to the value to copy.</param>
75 </member>
76 <member name="M:System.Runtime.CompilerServices.Unsafe.AsPointer``1(``0@)">
77 <summary>
78 Returns a pointer to the given by-ref parameter.
79 </summary>
80 <typeparam name="T">The type of object.</typeparam>
81 <param name="value">The object whose pointer is obtained.</param>
82 <returns>A pointer to the given value.</returns>
83 </member>
84 <member name="M:System.Runtime.CompilerServices.Unsafe.SizeOf``1">
85 <summary>
86 Returns the size of an object of the given type parameter.
87 </summary>
88 <typeparam name="T">The type of object whose size is retrieved.</typeparam>
89 <returns>The size of an object of type <typeparamref name="T"/>.</returns>
90 </member>
91 <member name="M:System.Runtime.CompilerServices.Unsafe.As``1(System.Object)">
92 <summary>
93 Casts the given object to the specified type, performs no dynamic type checking.
94 </summary>
95 <typeparam name="T">The type which the object will be cast to.</typeparam>
96 <param name="o">The object to cast.</param>
97 <returns>The original object, casted to the given type.</returns>
98 </member>
99 <member name="M:System.Runtime.CompilerServices.Unsafe.AsRef``1(System.Void*)">
100 <summary>
101 Reinterprets the given location as a reference to a value of type <typeparamref name="T"/>.
102 </summary>
103 <typeparam name="T">The type of the interpreted location.</typeparam>
104 <param name="source">The location of the value to reference.</param>
105 <returns>A reference to a value of type <typeparamref name="T"/>.</returns>
106 </member>
107 <member name="M:System.Runtime.CompilerServices.Unsafe.AsRef``1(``0@)">
108 <summary>
109 Reinterprets the given read-only reference as a reference.
110 </summary>
111 <typeparam name="T">The type of reference.</typeparam>
112 <param name="source">The read-only reference to reinterpret.</param>
113 <returns>A reference to a value of type <typeparamref name="T"/>.</returns>
114 </member>
115 <member name="M:System.Runtime.CompilerServices.Unsafe.As``2(``0@)">
116 <summary>
117 Reinterprets the given reference as a reference to a value of type <typeparamref name="TTo"/>.
118 </summary>
119 <typeparam name="TFrom">The type of reference to reinterpret.</typeparam>
120 <typeparam name="TTo">The desired type of the reference.</typeparam>
121 <param name="source">The reference to reinterpret.</param>
122 <returns>A reference to a value of type <typeparamref name="TTo"/>.</returns>
123 </member>
124 <member name="M:System.Runtime.CompilerServices.Unsafe.Unbox``1(System.Object)">
125 <summary>
126 Returns a reference to the value type contained with the specified box object.
127 </summary>
128 <typeparam name="T">The type of the value type contained within the box.</typeparam>
129 <param name="box">The boxed value type.</param>
130 <returns>A reference to a value of type <typeparamref name="T"/> in the box object.</returns>
131 </member>
132 <member name="M:System.Runtime.CompilerServices.Unsafe.Add``1(``0@,System.Int32)">
133 <summary>
134 Adds an element offset to the given reference.
135 </summary>
136 <typeparam name="T">The type of reference.</typeparam>
137 <param name="source">The reference to add the offset to.</param>
138 <param name="elementOffset">The offset to add.</param>
139 <returns>A new reference that reflects the addition of offset to pointer.</returns>
140 </member>
141 <member name="M:System.Runtime.CompilerServices.Unsafe.Add``1(System.Void*,System.Int32)">
142 <summary>
143 Adds an element offset to the given pointer.
144 </summary>
145 <typeparam name="T">The type of reference.</typeparam>
146 <param name="source">The pointer to add the offset to.</param>
147 <param name="elementOffset">The offset to add.</param>
148 <returns>A new pointer that reflects the addition of offset to pointer.</returns>
149 </member>
150 <member name="M:System.Runtime.CompilerServices.Unsafe.Add``1(``0@,System.IntPtr)">
151 <summary>
152 Adds an element offset to the given reference.
153 </summary>
154 <typeparam name="T">The type of reference.</typeparam>
155 <param name="source">The reference to add the offset to.</param>
156 <param name="elementOffset">The offset to add.</param>
157 <returns>A new reference that reflects the addition of offset to pointer.</returns>
158 </member>
159 <member name="M:System.Runtime.CompilerServices.Unsafe.AddByteOffset``1(``0@,System.IntPtr)">
160 <summary>
161 Adds a byte offset to the given reference.
162 </summary>
163 <typeparam name="T">The type of reference.</typeparam>
164 <param name="source">The reference to add the offset to.</param>
165 <param name="byteOffset">The offset to add.</param>
166 <returns>A new reference that reflects the addition of byte offset to pointer.</returns>
167 </member>
168 <member name="M:System.Runtime.CompilerServices.Unsafe.Subtract``1(``0@,System.Int32)">
169 <summary>
170 Subtracts an element offset from the given reference.
171 </summary>
172 <typeparam name="T">The type of reference.</typeparam>
173 <param name="source">The reference to subtract the offset from.</param>
174 <param name="elementOffset">The offset to subtract.</param>
175 <returns>A new reference that reflects the subraction of offset from pointer.</returns>
176 </member>
177 <member name="M:System.Runtime.CompilerServices.Unsafe.Subtract``1(``0@,System.IntPtr)">
178 <summary>
179 Subtracts an element offset from the given reference.
180 </summary>
181 <typeparam name="T">The type of reference.</typeparam>
182 <param name="source">The reference to subtract the offset from.</param>
183 <param name="elementOffset">The offset to subtract.</param>
184 <returns>A new reference that reflects the subraction of offset from pointer.</returns>
185 </member>
186 <member name="M:System.Runtime.CompilerServices.Unsafe.SubtractByteOffset``1(``0@,System.IntPtr)">
187 <summary>
188 Subtracts a byte offset from the given reference.
189 </summary>
190 <typeparam name="T">The type of reference.</typeparam>
191 <param name="source">The reference to subtract the offset from.</param>
192 <param name="bytesOffset">The offset to subtract.</param>
193 <returns>A new reference that reflects the subraction of byte offset from pointer.</returns>
194 </member>
195 <member name="M:System.Runtime.CompilerServices.Unsafe.ByteOffset``1(``0@,``0@)">
196 <summary>
197 Determines the byte offset from origin to target from the given references.
198 </summary>
199 <typeparam name="T">The type of reference.</typeparam>
200 <param name="origin">The reference to origin.</param>
201 <param name="target">The reference to target.</param>
202 <returns>Byte offset from origin to target i.e. <paramref name="target"/> - <paramref name="origin"/>.</returns>
203 </member>
204 <member name="M:System.Runtime.CompilerServices.Unsafe.AreSame``1(``0@,``0@)">
205 <summary>
206 Determines whether the specified references point to the same location.
207 </summary>
208 <param name="left">The first reference to compare.</param>
209 <param name="right">The second reference to compare.</param>
210 <returns><c>true</c> if <paramref name="left"/> and <paramref name="right"/> point to the same location; otherwise <c>false</c>.</returns>
211 </member>
212 <member name="M:System.Runtime.CompilerServices.Unsafe.IsAddressGreaterThan``1(``0@,``0@)">
213 <summary>
214 Determines whether the memory address referenced by <paramref name="left"/> is greater than the memory address referenced by <paramref name="right"/>.
215 </summary>
216 <param name="left">The first reference to compare.</param>
217 <param name="right">The second reference to compare.</param>
218 <returns><c>true</c> if the memory address referenced by <paramref name="left"/> is greater than the memory address referenced by <paramref name="right"/>; otherwise <c>false</c>.</returns>
219 <remarks>
220 This check is conceptually similar to "(void*)(&left) > (void*)(&right)". Both parameters must reference the same object, array, or span;
221 or the objects being referenced must both be pinned; or both references must represent unmanaged pointers; otherwise the result is undefined.
222 </remarks>
223 </member>
224 <member name="M:System.Runtime.CompilerServices.Unsafe.IsAddressLessThan``1(``0@,``0@)">
225 <summary>
226 Determines whether the memory address referenced by <paramref name="left"/> is less than the memory address referenced by <paramref name="right"/>.
227 </summary>
228 <param name="left">The first reference to compare.</param>
229 <param name="right">The second reference to compare.</param>
230 <returns><c>true</c> if the memory address referenced by <paramref name="left"/> is less than the memory address referenced by <paramref name="right"/>; otherwise <c>false</c>.</returns>
231 <remarks>
232 This check is conceptually similar to "(void*)(&left) < (void*)(&right)". Both parameters must reference the same object, array, or span;
233 or the objects being referenced must both be pinned; or both references must represent unmanaged pointers; otherwise the result is undefined.
234 </remarks>
235 </member>
236 <member name="M:System.Runtime.CompilerServices.Unsafe.CopyBlock(System.Void*,System.Void*,System.UInt32)">
237 <summary>
238 Copies bytes from the source address to the destination address.
239 </summary>
240 <param name="destination">The destination address to copy to.</param>
241 <param name="source">The source address to copy from.</param>
242 <param name="byteCount">The number of bytes to copy.</param>
243 </member>
244 <member name="M:System.Runtime.CompilerServices.Unsafe.CopyBlock(System.Byte@,System.Byte@,System.UInt32)">
245 <summary>
246 Copies bytes from the source address to the destination address.
247 </summary>
248 <param name="destination">The destination address to copy to.</param>
249 <param name="source">The source address to copy from.</param>
250 <param name="byteCount">The number of bytes to copy.</param>
251 </member>
252 <member name="M:System.Runtime.CompilerServices.Unsafe.CopyBlockUnaligned(System.Void*,System.Void*,System.UInt32)">
253 <summary>
254 Copies bytes from the source address to the destination address
255 without assuming architecture dependent alignment of the addresses.
256 </summary>
257 <param name="destination">The destination address to copy to.</param>
258 <param name="source">The source address to copy from.</param>
259 <param name="byteCount">The number of bytes to copy.</param>
260 </member>
261 <member name="M:System.Runtime.CompilerServices.Unsafe.CopyBlockUnaligned(System.Byte@,System.Byte@,System.UInt32)">
262 <summary>
263 Copies bytes from the source address to the destination address
264 without assuming architecture dependent alignment of the addresses.
265 </summary>
266 <param name="destination">The destination address to copy to.</param>
267 <param name="source">The source address to copy from.</param>
268 <param name="byteCount">The number of bytes to copy.</param>
269 </member>
270 <member name="M:System.Runtime.CompilerServices.Unsafe.InitBlock(System.Void*,System.Byte,System.UInt32)">
271 <summary>
272 Initializes a block of memory at the given location with a given initial value.
273 </summary>
274 <param name="startAddress">The address of the start of the memory block to initialize.</param>
275 <param name="value">The value to initialize the block to.</param>
276 <param name="byteCount">The number of bytes to initialize.</param>
277 </member>
278 <member name="M:System.Runtime.CompilerServices.Unsafe.InitBlock(System.Byte@,System.Byte,System.UInt32)">
279 <summary>
280 Initializes a block of memory at the given location with a given initial value.
281 </summary>
282 <param name="startAddress">The address of the start of the memory block to initialize.</param>
283 <param name="value">The value to initialize the block to.</param>
284 <param name="byteCount">The number of bytes to initialize.</param>
285 </member>
286 <member name="M:System.Runtime.CompilerServices.Unsafe.InitBlockUnaligned(System.Void*,System.Byte,System.UInt32)">
287 <summary>
288 Initializes a block of memory at the given location with a given initial value
289 without assuming architecture dependent alignment of the address.
290 </summary>
291 <param name="startAddress">The address of the start of the memory block to initialize.</param>
292 <param name="value">The value to initialize the block to.</param>
293 <param name="byteCount">The number of bytes to initialize.</param>
294 </member>
295 <member name="M:System.Runtime.CompilerServices.Unsafe.InitBlockUnaligned(System.Byte@,System.Byte,System.UInt32)">
296 <summary>
297 Initializes a block of memory at the given location with a given initial value
298 without assuming architecture dependent alignment of the address.
299 </summary>
300 <param name="startAddress">The address of the start of the memory block to initialize.</param>
301 <param name="value">The value to initialize the block to.</param>
302 <param name="byteCount">The number of bytes to initialize.</param>
303 </member>
304 </members>
305</doc>