Skip to content
Removing yvs and replacing with zukini everywhere appropriate. authored by Kevin Meaney's avatar Kevin Meaney
...@@ -51,7 +51,7 @@ Each filter in a filter chain, is described by the filter name, a name identifie ...@@ -51,7 +51,7 @@ Each filter in a filter chain, is described by the filter name, a name identifie
```json ```json
{ {
"cifiltername": "CIUnsharpMask", "cifiltername": "CIUnsharpMask",
"mifiltername" : "com.yvs.documentation.renderingfilterchain.unsharpmask", "mifiltername" : "com.zukini.documentation.renderingfilterchain.unsharpmask",
"cifilterproperties": [ "cifilterproperties": [
{ {
"cifilterkey": "inputRadius", "cifilterkey": "inputRadius",
...@@ -72,7 +72,7 @@ Each filter in a filter chain, is described by the filter name, a name identifie ...@@ -72,7 +72,7 @@ Each filter in a filter chain, is described by the filter name, a name identifie
} }
``` ```
In the above json example, the core image filter to be created is a Core Image Unsharp Mask filter. The filter is given the identifier "com.yvs.documentation.renderingfilterchain.unsharpmask" and the filter takes three inputs. These are the input radius, which takes a numeric value, the input intensity which also takes a numeric value and an input image which takes a dictionary/json object which describes how to obtain the image. In the above json example, the core image filter to be created is a Core Image Unsharp Mask filter. The filter is given the identifier "com.zukini.documentation.renderingfilterchain.unsharpmask" and the filter takes three inputs. These are the input radius, which takes a numeric value, the input intensity which also takes a numeric value and an input image which takes a dictionary/json object which describes how to obtain the image.
When an input is an image, then the input value is a way to obtain the image and is a json object. The image can be sourced as the output image of a previous filter in the filter chain and if that was the case then the key in the object would be "cifilterindex" and the value is an index to an earlier filter in the filter chain or a key "mifiltername" and the value would be a string which is the name identifier of the earlier filter. If the image is sourced from a bitmap context then the key in the object would be "objectreference" as in the above example which refers to a base object with reference 0. The image can also come from an image importer object in which case the "objectreference" key is also used but that a "imageindex" key should also be supplied specifying the index of the image in the image file. If "imageindex" is not specified and the object reference refers to an image importer object then "imageindex" defaults to 0. When obtaining an image from an object like an image importer, bitmap context, or movie importer the objecttype/objectname combination can be used in place of objectreference to obtain the object to obtain the image from. When an input is an image, then the input value is a way to obtain the image and is a json object. The image can be sourced as the output image of a previous filter in the filter chain and if that was the case then the key in the object would be "cifilterindex" and the value is an index to an earlier filter in the filter chain or a key "mifiltername" and the value would be a string which is the name identifier of the earlier filter. If the image is sourced from a bitmap context then the key in the object would be "objectreference" as in the above example which refers to a base object with reference 0. The image can also come from an image importer object in which case the "objectreference" key is also used but that a "imageindex" key should also be supplied specifying the index of the image in the image file. If "imageindex" is not specified and the object reference refers to an image importer object then "imageindex" defaults to 0. When obtaining an image from an object like an image importer, bitmap context, or movie importer the objecttype/objectname combination can be used in place of objectreference to obtain the object to obtain the image from.
...@@ -93,7 +93,7 @@ When a filter takes a numeric input, then the "cifiltervalueclass" key is not ne ...@@ -93,7 +93,7 @@ When a filter takes a numeric input, then the "cifiltervalueclass" key is not ne
The above filter description, was generated from the following ruby script: The above filter description, was generated from the following ruby script:
```ruby ```ruby
unsharpmask_filter = MIFilter.new(:CIUnsharpMask, identifier: 'com.yvs.documentation.renderingfilterchain.unsharpmask') unsharpmask_filter = MIFilter.new(:CIUnsharpMask, identifier: 'com.zukini.documentation.renderingfilterchain.unsharpmask')
radius_property = MIFilterProperty.make_cinumberproperty(key: :inputRadius, value: 2.5) radius_property = MIFilterProperty.make_cinumberproperty(key: :inputRadius, value: 2.5)
unsharpmask_filter.add_property(radius_property) unsharpmask_filter.add_property(radius_property)
intensity_property = MIFilterProperty.make_cinumberproperty(key: :inputIntensity, value: 1.0) intensity_property = MIFilterProperty.make_cinumberproperty(key: :inputIntensity, value: 1.0)
...@@ -110,7 +110,7 @@ In the following example the json object represents the information needed for c ...@@ -110,7 +110,7 @@ In the following example the json object represents the information needed for c
```json ```json
{ {
"cifiltername": "CIRadialGradient", "cifiltername": "CIRadialGradient",
"mifiltername": "com.yvs.renderingfilterchain.example.radialfilter", "mifiltername": "com.zukini.renderingfilterchain.example.radialfilter",
"cifilterproperties": [ "cifilterproperties": [
{ {
"cifilterkey": "inputCenter", "cifilterkey": "inputCenter",
...@@ -154,7 +154,7 @@ In the following example the json object represents the information needed for c ...@@ -154,7 +154,7 @@ In the following example the json object represents the information needed for c
The ruby code to generate the above json representation of the radial gradient filter is below: The ruby code to generate the above json representation of the radial gradient filter is below:
```ruby ```ruby
radialgradient_filter = MIFilter.new(:CIRadialGradient, identifier: 'com.yvs.renderingfilterchain.example.radialfilter') radialgradient_filter = MIFilter.new(:CIRadialGradient, identifier: 'com.zukini.renderingfilterchain.example.radialfilter')
center_property = MIFilterProperty.make_civectorproperty_fromarray(key: :inputCenter, center_property = MIFilterProperty.make_civectorproperty_fromarray(key: :inputCenter,
value: [200, 200]) value: [200, 200])
radialgradient_filter.add_property(center_property) radialgradient_filter.add_property(center_property)
...@@ -585,7 +585,7 @@ If the base object reference identifies a "imageimporter" object or if the "obje ...@@ -585,7 +585,7 @@ If the base object reference identifies a "imageimporter" object or if the "obje
"cifiltervalueclass": "CIImage", "cifiltervalueclass": "CIImage",
"cifiltervalue": { "cifiltervalue": {
"objecttype": "imageimporter", "objecttype": "imageimporter",
"objectname": "yvs.com.documentation.renderingfilterchain.imageimporter", "objectname": "zukini.com.documentation.renderingfilterchain.imageimporter",
"imageindex": 1 "imageindex": 1
} }
} }
...@@ -610,7 +610,7 @@ Render destination example 2: ...@@ -610,7 +610,7 @@ Render destination example 2:
{ {
"cirenderdestination": { "cirenderdestination": {
"objecttype": "bitmapcontext", "objecttype": "bitmapcontext",
"objectname" : "com.yvs.renderdestination.example2" "objectname" : "com.zukini.renderdestination.example2"
}, },
... ...
} }
...@@ -818,15 +818,15 @@ The following demonstrates the three ways of creating an image filter chain obje ...@@ -818,15 +818,15 @@ The following demonstrates the three ways of creating an image filter chain obje
Creating an image filter chain object with the json object defined on the command line: Creating an image filter chain object with the json object defined on the command line:
smig create -type "imagefilterchain" -name "com.yvs.documentation.unsharpmaskfilterchain" -jsonstring '{"cifiltername":"CIUnsharpMask","mifiltername":"com.yvs.documentation.renderingfilterchain.unsharpmask","cifilterproperties":[{"cifilterkey":"inputRadius","cifiltervalue":2.5},{"cifilterkey":"inputIntensity","cifiltervalue":1},{"cifilterkey":"inputImage","cifiltervalueclass":"CIImage","cifiltervalue":{"objectreference":0}}]}' smig create -type "imagefilterchain" -name "com.zukini.documentation.unsharpmaskfilterchain" -jsonstring '{"cifiltername":"CIUnsharpMask","mifiltername":"com.zukini.documentation.renderingfilterchain.unsharpmask","cifilterproperties":[{"cifilterkey":"inputRadius","cifiltervalue":2.5},{"cifilterkey":"inputIntensity","cifiltervalue":1},{"cifilterkey":"inputImage","cifiltervalueclass":"CIImage","cifiltervalue":{"objectreference":0}}]}'
Creating an image filter chain object with the json object defined in a json file: Creating an image filter chain object with the json object defined in a json file:
smig create -type "imagefilterchain" -name "com.yvs.documentation.unsharpmaskfilterchain" -jsonfile "~/JSONFilterFiles/unsharpmask.json" smig create -type "imagefilterchain" -name "com.zukini.documentation.unsharpmaskfilterchain" -jsonfile "~/JSONFilterFiles/unsharpmask.json"
Creating an image filter chain object with the property list dictionary defined in a property list file: Creating an image filter chain object with the property list dictionary defined in a property list file:
smig create -type "imagefilterchain" -name "com.yvs.documentation.unsharpmaskfilterchain" -propertyfile "~/PLISTFilterFiles/unsharpmask.plist" smig create -type "imagefilterchain" -name "com.zukini.documentation.unsharpmaskfilterchain" -propertyfile "~/PLISTFilterFiles/unsharpmask.plist"
### The Image Filter Chain Ruby Processing Scripts ### The Image Filter Chain Ruby Processing Scripts
...@@ -948,7 +948,7 @@ The following shows a json object representation of the properties needed to def ...@@ -948,7 +948,7 @@ The following shows a json object representation of the properties needed to def
{ {
"cifiltername": "YVSChromaKeyFilter", "cifiltername": "YVSChromaKeyFilter",
"mifiltername" : "com.yvs.documentation.renderingfilterchain.chromakey", "mifiltername" : "com.zukini.documentation.renderingfilterchain.chromakey",
"cifilterproperties": [ "cifilterproperties": [
{ {
"cifilterkey": "inputDistance", "cifilterkey": "inputDistance",
... ...
......