Browse Source

Sync SDL3 wiki -> header

[ci skip]
SDL Wiki Bot 2 days ago
parent
commit
5832fd6fc5
1 changed files with 15 additions and 6 deletions
  1. 15 6
      include/SDL3/SDL_properties.h

+ 15 - 6
include/SDL3/SDL_properties.h

@@ -83,14 +83,23 @@ typedef enum SDL_PropertyType
 /**
  * A generic property for naming things.
  *
- * This property is intended to be added to any property set that needs the
- * set named, or needs a generic name for the object that the properties are
- * associated with. It is not guaranteed that any property set will include
- * this property, but it is convenient to have a standard property name that
- * any piece of code could reasonable agree to use.
+ * This property is intended to be added to any SDL_PropertiesID that needs a
+ * generic name associated with the property set. It is not guaranteed that
+ * any property set will include this key, but it is convenient to have a
+ * standard key that any piece of code could reasonably agree to use.
+ *
+ * For example, the properties associated with an SDL_Texture might have a
+ * name string of "player sprites", or an SDL_AudioStream might have
+ * "background music", etc. This might also be useful for an SDL_IOStream to
+ * list the path to its asset.
  *
  * There is no format for the value set with this key; it is expected to be
- * human-readable.
+ * human-readable and informational in nature, possibly for logging or
+ * debugging purposes.
+ *
+ * SDL does not currently set this property on any objects it creates, but
+ * this may change in later versions; it is currently expected that apps and
+ * external libraries will take advantage of it, when appropriate.
  *
  * \since This macro is available since SDL 3.4.0.
  */