Skip to content

[src] Import xml docs for members, part 19. #22656

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Apr 23, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions docs/api/GameplayKit/IGKGameModelUpdate.xml
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
<Documentation>
<Docs DocId="P:GameplayKit.IGKGameModelUpdate.Value">
<summary>Equivalent to the value produced by <see cref="M:GameplayKit.GKGameModel_Extensions.GetScore(GameplayKit.IGKGameModel,GameplayKit.IGKGameModelPlayer)" />.</summary>
<value>To be added.</value>
<remarks>
<para>This property is determined by the <see cref="M:GameplayKit.GKGameModel_Extensions.GetScore(GameplayKit.IGKGameModel,GameplayKit.IGKGameModelPlayer)" /> when <c>this</c><see cref="T:GameplayKit.IGKGameModelUpdate" /> is applied to the game state of the <see cref="T:GameplayKit.IGKGameModel" />. Ultimately, the <see cref="M:GameplayKit.GKMinMaxStrategist.GetBestMove(GameplayKit.IGKGameModelPlayer)" /> method returns the <see cref="T:GameplayKit.IGKGameModelUpdate" /> with the highest <see cref="P:GameplayKit.IGKGameModelUpdate.Value" />. If multiple <see cref="T:GameplayKit.IGKGameModelUpdate" /> have the same <see cref="P:GameplayKit.IGKGameModelUpdate.Value" /> and <format type="text/html"><a href="https://docs.microsoft.com/en-us/search/index?search=Gameplay%20Kit%20GKMin%20Max%20Strategist%20Random&amp;scope=Xamarin" title="P:GameplayKit.GKMinMaxStrategist.Random">P:GameplayKit.GKMinMaxStrategist.Random</a></format> is not <see langword="null" />, the returned <see cref="T:GameplayKit.IGKGameModelUpdate" /> is chosen randomly among those with the highest <see cref="P:GameplayKit.IGKGameModelUpdate.Value" />.</para>
</remarks>
</Docs>
</Documentation>
2,351 changes: 2,348 additions & 3 deletions src/appkit.cs

Large diffs are not rendered by default.

4 changes: 4 additions & 0 deletions src/arkit.cs
Original file line number Diff line number Diff line change
Expand Up @@ -1325,6 +1325,10 @@ interface ARSCNDebugOptions {
[NoTV, NoMac]
[Protocol]
interface ARTrackable {
/// <summary>Whether the ARKit-calculated transform matches the real-world position and rotation.</summary>
/// <value>
/// <see langword="true" /> if the transform accurately represents the real-world position and rotation of the detected object.</value>
/// <remarks>To be added.</remarks>
[Abstract]
[Export ("isTracked")]
bool IsTracked { get; }
Expand Down
63 changes: 63 additions & 0 deletions src/audiounit.cs
Original file line number Diff line number Diff line change
Expand Up @@ -626,65 +626,123 @@ AUParameterTree ParameterTree {
[BaseType (typeof (AUAudioUnit))]
interface AUAudioUnit_AUAudioInputOutputUnit {

/// <summary>To be added.</summary>
/// <returns>To be added.</returns>
/// <remarks>To be added.</remarks>
[NoTV, NoiOS]
[NoMacCatalyst]
[Export ("deviceID")]
uint GetDeviceId ();

/// <param name="deviceID">To be added.</param>
/// <param name="outError">To be added.</param>
/// <summary>To be added.</summary>
/// <returns>To be added.</returns>
/// <remarks>To be added.</remarks>
[NoTV, NoiOS]
[NoMacCatalyst]
[Export ("setDeviceID:error:")]
bool SetDeviceId (uint deviceID, out NSError outError);

/// <summary>Returns a Boolean value that tells whether the audio unit can perform input operations.</summary>
/// <returns>To be added.</returns>
/// <remarks>To be added.</remarks>
[Export ("canPerformInput")]
bool GetCanPerformInput ();

/// <summary>Returns a Boolean value that tells whether the audio unit can perform output operations.</summary>
/// <returns>To be added.</returns>
/// <remarks>To be added.</remarks>
[Export ("canPerformOutput")]
bool CanPerformOutput ();

/// <summary>Returns a Boolean value that tells whether input is currently enabled on the audio unit.</summary>
/// <returns>To be added.</returns>
/// <remarks>To be added.</remarks>
[Export ("isInputEnabled")]
bool IsInputEnabled ();

/// <param name="enabled">To be added.</param>
/// <summary>Sets a Boolean value that controls whether input is enabled on the audio unit.</summary>
/// <returns>To be added.</returns>
/// <remarks>To be added.</remarks>
[Export ("setInputEnabled:")]
bool SetInputEnabled (bool enabled);

/// <summary>Returns a Boolean value that tells whether input is currently enabled on the audio unit.</summary>
/// <returns>To be added.</returns>
/// <remarks>To be added.</remarks>
[Export ("isOutputEnabled")]
bool IsOutputEnabled ();

/// <param name="enabled">To be added.</param>
/// <summary>Sets a Boolean value that controls whether output is enabled on the audio unit..</summary>
/// <returns>To be added.</returns>
/// <remarks>To be added.</remarks>
[Export ("setOutputEnabled:")]
bool SetOutputEnabled (bool enabled);

/// <summary>Gets the input handler for this IO unit</summary>
/// <returns>To be added.</returns>
/// <remarks>To be added.</remarks>
[return: NullAllowed]
[Export ("inputHandler", ArgumentSemantic.Copy)]
AUInputHandler GetInputHandler ();

/// <param name="handler">The handler to set.</param>
/// <summary>Sets the input handler to the specified value.</summary>
/// <remarks>To be added.</remarks>
[Export ("setInputHandler:")]
void SetInputHandler ([NullAllowed] AUInputHandler handler);

/// <param name="outError">
/// <para>To be added.</para>
/// <para tool="nullallowed">This parameter can be <see langword="null" />.</para>
/// </param>
/// <summary>Starts the audio unit's hardware.</summary>
/// <returns>To be added.</returns>
/// <remarks>To be added.</remarks>
[Export ("startHardwareAndReturnError:")]
bool StartHardware ([NullAllowed] out NSError outError);

/// <summary>Stops the audio unit's hardware.</summary>
/// <remarks>To be added.</remarks>
[Export ("stopHardware")]
void StopHardware ();

/// <summary>Gets the output provider for this IO unit.</summary>
/// <returns>To be added.</returns>
/// <remarks>To be added.</remarks>
[return: NullAllowed]
[Export ("outputProvider", ArgumentSemantic.Copy)]
AURenderPullInputBlock GetOutputProvider ();

/// <param name="provider">The provider to set.</param>
/// <summary>Sets the output provider to the specified value.</summary>
/// <remarks>To be added.</remarks>
[Export ("setOutputProvider:")]
void SetOutputProvider ([NullAllowed] AURenderPullInputBlock provider);

// the following are properties but we cannot have properties in Categories.
/// <summary>To be added.</summary>
/// <returns>To be added.</returns>
/// <remarks>To be added.</remarks>
[NoiOS, NoTV]
[NoMacCatalyst]
[Export ("deviceInputLatency")]
double GetDeviceInputLatency ();

/// <summary>To be added.</summary>
/// <returns>To be added.</returns>
/// <remarks>To be added.</remarks>
[NoiOS, NoTV]
[NoMacCatalyst]
[Export ("deviceOutputLatency")]
double GetDeviceOutputLatency ();

/// <summary>To be added.</summary>
/// <returns>To be added.</returns>
/// <remarks>To be added.</remarks>
[MacCatalyst (13, 1)]
[Export ("running")]
bool IsRunning ();
Expand Down Expand Up @@ -1240,6 +1298,11 @@ interface AUParameterTree : NSSecureCoding {
/// </remarks>
[Protocol]
interface AUAudioUnitFactory : NSExtensionRequestHandling {
/// <param name="desc">A description for the audio unit.</param>
/// <param name="error">An <see langword="out" /> parameter into which any errors that are encountered are written.</param>
/// <summary>Creates and returns an audio unit.</summary>
/// <returns>An audio unit.</returns>
/// <remarks>To be added.</remarks>
[Abstract]
[Export ("createAudioUnitWithComponentDescription:error:")]
[return: NullAllowed]
Expand Down
Loading