Skip to content

Commit

Permalink
Header documentation formatting
Browse files Browse the repository at this point in the history
  • Loading branch information
bangnoise committed Aug 31, 2020
1 parent 69647a0 commit b908d77
Show file tree
Hide file tree
Showing 3 changed files with 6 additions and 31 deletions.
5 changes: 0 additions & 5 deletions SyphonOpenGLClient.h
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,6 @@ NS_ASSUME_NONNULL_BEGIN
@param handler A block which is invoked when a new frame becomes available. handler may be nil. This block may be invoked on a thread other than that on which the client was created.
@returns A newly initialized SyphonOpenGLClient object, or nil if a client could not be created.
*/

- (id)initWithServerDescription:(NSDictionary *)description context:(CGLContextObj)context options:(nullable NSDictionary *)options newFrameHandler:(nullable void (^)(SYPHON_OPENGL_CLIENT_UNIQUE_CLASS_NAME *client))handler;

/*!
Expand All @@ -66,19 +65,16 @@ NS_ASSUME_NONNULL_BEGIN
/*!
A client is valid if it has a working connection to a server. Once this returns NO, the SyphonOpenGLClient will not yield any further frames.
*/

@property (readonly) BOOL isValid;

/*!
Returns a dictionary with a description of the server the client is attached to. See SyphonServerDirectory for the keys this dictionary contains
*/

@property (readonly) NSDictionary *serverDescription;

/*!
Returns YES if the server has output a new frame since the last time newFrameImage was called for this client, NO otherwise.
*/

@property (readonly) BOOL hasNewFrame;

/*!
Expand All @@ -97,7 +93,6 @@ NS_ASSUME_NONNULL_BEGIN
This method may perform work in the OpenGL context. As with any other OpenGL calls, you must ensure no other threads use those contexts during calls to this method.
*/

- (void)stop;

@end
Expand Down
15 changes: 3 additions & 12 deletions SyphonOpenGLServer.h
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,6 @@ extern NSString * const SyphonServerOptionIsPrivate;
/*!
@relates SyphonServerBase
If this key is matched with a NSNumber with a NSUInteger value greater than zero, the server will, when using the bindToDrawFrameOfSize / unbindAndPublish API, render to an antialiased render buffer with the requested multisample count (via the FBO MSAA and BLIT extensions). Default sample count is 0 should this key be ommited, indicating no antialiased buffers will be used. If the requested sample count is not supported by the GL context, the nearest supported sample count will be used instead. If MSAA is not supported at all, this key will be ignored and the server will render without the antialiasing stage.
*/
extern NSString * const SyphonServerOptionAntialiasSampleCount;

Expand Down Expand Up @@ -90,7 +89,6 @@ extern NSString * const SyphonServerOptionStencilBufferResolution;
@param options A dictionary containing key-value pairs to specify options for the server. Currently supported options are SyphonServerOptionIsPrivate, SyphonServerOptionAntialiasQuality and SyphonServerOptionHasDepthBuffer. See their descriptions for details.
@returns A newly intialized SyphonOpenGLServer. Nil on failure.
*/

- (instancetype)initWithName:(nullable NSString*)serverName context:(CGLContextObj)context options:(nullable NSDictionary *)options;

/** @} */
Expand All @@ -100,25 +98,21 @@ extern NSString * const SyphonServerOptionStencilBufferResolution;
/*!
The CGLContext the server uses for drawing. This may or may not be the context passed in at init.
*/

@property (readonly) CGLContextObj context;

/*!
A string representing the name of the SyphonOpenGLServer.
*/

*/
@property (nullable, retain) NSString* name;

/*!
A dictionary describing the server. Normally you won't need to access this, however if you created the server as private (using SyphonServerOptionIsPrivate) then you must pass this dictionary to any process in which you wish to create a SyphonClient. You should not rely on the presence of any particular keys in this dictionary. The content will always conform to the \<NSCoding\> protocol.
*/

@property (readonly) NSDictionary* serverDescription;

/*!
YES if clients are currently attached, NO otherwise. If you generate frames frequently (for instance on a display-link timer), you may choose to test this and only call publishFrameTexture:textureTarget:imageRegion:textureDimensions:flipped: when clients are attached.
*/

*/
@property (readonly) BOOL hasClients;

/** @} */
Expand All @@ -138,7 +132,6 @@ YES if clients are currently attached, NO otherwise. If you generate frames freq
@param size The full size of the texture
@param isFlipped Is the texture flipped?
*/

- (void)publishFrameTexture:(GLuint)texID textureTarget:(GLenum)target imageRegion:(NSRect)region textureDimensions:(NSSize)size flipped:(BOOL)isFlipped;

/*!
Expand All @@ -151,7 +144,6 @@ YES if clients are currently attached, NO otherwise. If you generate frames freq
@param size The size the frame you wish to publish.
@returns YES if binding succeeded, NO otherwise.
*/

- (BOOL)bindToDrawFrameOfSize:(NSSize)size;

/*!
Expand All @@ -161,7 +153,6 @@ YES if clients are currently attached, NO otherwise. If you generate frames freq
In legacy OpenGL contexts the previous FBO binding is restored. In Core Profile OpenGL contexts the default (0) FBO is restored. No other state is modified.
*/

- (void)unbindAndPublish;

/*!
Expand All @@ -174,8 +165,8 @@ YES if clients are currently attached, NO otherwise. If you generate frames freq
/*!
Stops the server instance. Use of this method is optional and releasing all references to the server has the same effect.
*/

- (void)stop;

/** @} */
@end

Expand Down
17 changes: 3 additions & 14 deletions SyphonServerDirectory.h
Original file line number Diff line number Diff line change
Expand Up @@ -37,30 +37,25 @@ NS_ASSUME_NONNULL_BEGIN
/*!
@relates SyphonServerDirectory
The object for this key is a NSString which uniquely identifies a SyphonServer instance. If two dictionaries contain the same string for this key, they represent the same server. This is provided solely to allow you to programmatically determine the identity of a server, and should never be displayed to users in interface elements. This key is not guaranteed to exist in the dictionary.
*/

extern NSString * const SyphonServerDescriptionUUIDKey;

/*!
@relates SyphonServerDirectory
The object for this key is a NSString which is the human-readable non-unique name for the SyphonServer. If this string exists and is non-empty, you should use it in interface elements to identify the server, usually in combination with the name of the server's application (see SyphonServerDescriptionAppNameKey). This key is not guaranteed to exist in the dictionary.
*/

extern NSString * const SyphonServerDescriptionNameKey;

/*!
@relates SyphonServerDirectory
The object for this key is a NSString with the localized name of the application in which the SyphonServer is running. Use this in combination with the server's name (if present) to identify the server in interface elements. This key is not guaranteed to exist in the dictionary.
*/

extern NSString * const SyphonServerDescriptionAppNameKey;

/*!
@relates SyphonServerDirectory
The object for this key is a NSImage representation of the icon of the application in which the SyphonServer is running. This key is not guaranteed to exist in the dictionary.
*/

extern NSString * const SyphonServerDescriptionIconKey;

/*! @} */
Expand All @@ -72,21 +67,18 @@ extern NSString * const SyphonServerDescriptionIconKey;
@relates SyphonServerDirectory
A new SyphonServer is available on the system. The notification object is the shared SyphonServerDirectory instance. The user info dictionary describes the server and may contain SyphonServerDescription keys.
*/

extern NSString * const SyphonServerAnnounceNotification;

/*!
@relates SyphonServerDirectory
An existing SyphonServer instance has changed its description. The notification object is the shared SyphonServerDirectory instance. The user info dictionary describes the server and may contain SyphonServerDescription keys.
*/

extern NSString * const SyphonServerUpdateNotification;

/*!
@relates SyphonServerDirectory
A SyphonServer instance will no longer be available. The notification object is the shared SyphonServerDirectory instance. The user info dictionary describes the retiring server and may contain SyphonServerDescription keys.
*/

extern NSString * const SyphonServerRetireNotification;

/*! @} */
Expand All @@ -103,23 +95,20 @@ extern NSString * const SyphonServerRetireNotification;
/*!
Returns the shared server directory instance. This object is KVO complaint, and can be used to observe changes in server availability, server names and statuses.
@returns the shared server instance
*/

*/
+ (SYPHON_SERVER_DIRECTORY_UNIQUE_CLASS_NAME *)sharedDirectory;

/*!
NSArray of NSDictionaries that describe (using the keys above) currently available SyphonServer instances on the system.
*/

*/
@property (readonly) NSArray *servers;

/*!
Use this method to discover servers based soley on their name, or application host name. Both parameters are optional. If you do not specify either, all available SyphonServers will be returned.
@param name Optional (pass nil to not specify) Name of the published SyphonServer, matches the key value for SyphonServerDescriptionNameKey
@param appname Optional (pass nil to not specify) Application Name of the published SyphonServer, matches the key value for SyphonServerDescriptionAppNameKey
@returns An array of NSDictionaries matching the query you specified.
*/

*/
- (NSArray *)serversMatchingName:(nullable NSString *)name appName:(nullable NSString *)appname;

@end
Expand Down

0 comments on commit b908d77

Please sign in to comment.